Merge branch 'rust-gamedev:source' into source

Author: cybersoulK

.github/create_newsletter_scaffold.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+if [[ -z "${NEWSLETTER_MONTH}" ]]; then
+  echo "NEWSLETTER_MONTH is not set. Exiting..."
+  exit 1
+fi
+
+if [[ -z "${NEWSLETTER_YEAR}" ]]; then
+  echo "NEWSLETTER_YEAR is not set. Exiting..."
+  exit 1
+fi
+
+if [[ -z "${NEWSLETTER_COUNTER}" ]]; then
+  echo "NEWSLETTER_COUNTER is not set. Exiting..."
+  exit 1
+fi
+
+# NEWSLETTER_NEXT_MONTH_NUMBER
+if [[ -z "${NEWSLETTER_NEXT_MONTH_NUMBER}" ]]; then
+  echo "NEWSLETTER_NEXT_MONTH_NUMBER is not set. Exiting..."
+  exit 1
+fi
+
+cp .github/newsletter-template.md index.md
+sed -i "s/{{\s*NEWSLETTER_MONTH\s*}}/${NEWSLETTER_MONTH}/g" index.md
+sed -i "s/{{\s*NEWSLETTER_YEAR\s*}}/${NEWSLETTER_YEAR}/g" index.md
+sed -i "s/{{\s*NEWSLETTER_COUNTER\s*}}/${NEWSLETTER_COUNTER}/g" index.md
+sed -i "s/{{\s*NEWSLETTER_NEXT_MONTH_NUMBER\s*}}/${NEWSLETTER_NEXT_MONTH_NUMBER}/g" index.md
+# Create a dir in content/news with the counter with 3 digits as name
+destination="content/news/$(printf "%03d" ${NEWSLETTER_COUNTER})"
+mkdir -p $destination
+mv index.md $destination/index.md
+git status

.github/newsletter-issue-template.md

@@ -0,0 +1,145 @@
+---
+title: "Newsletter {{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}"
+labels: coordination, help wanted
+assignees: AngelOnFira, mamaicode, janhohenheim
+---
+
+**Editors:** @janhohenheim, @AngelOnFira, @mamaicode
+
+Another month has gone by, so it's time to put together the Rust Gamedev newsletter with {{ env.NEWSLETTER_MONTH }}'s news!
+
+## Current Schedule
+
+The deadline for all section PRs is the **28th of {{ env.NEWSLETTER_MONTH}}, {{ env.NEWSLETTER_YEAR }}**. Submissions after this date will be added to the next newsletter.
+Our target release date is the **3rd of {{ env.NEWSLETTER_NEXT_MONTH }}, {{ env.NEWSLETTER_YEAR }}**.
+
+## Current Structure & Status
+
+Below is our current planned structure for the newsletter, and the status of each PR (which we'll try to keep updated).
+
+This is **not** an exhaustive list - if you have your own project that you want to write about, just make a comment on this issue and open a PR!
+
+### Game Updates
+
+None yet. Feel free to submit yours!
+
+### Learning Material Updates
+
+None yet. Feel free to submit yours!
+
+### Engine Updates
+
+None yet. Feel free to submit yours!
+
+### Tooling Updates
+
+None yet. Feel free to submit yours!
+
+### Library Updates
+
+None yet. Feel free to submit yours!
+
+### Other News
+
+None yet. Feel free to submit yours!
+
+### Discussions
+
+None yet. Feel free to submit yours!
+
+## Calls for Submissions
+
+### Social Media
+
+- [ ] Reddit
+- [ ] Lemmy
+- [ ] Mastodon
+- [ ] Twitter/X
+- [ ] Hacker News
+
+### Discord Servers
+
+- [ ] Rust GameDev
+- [ ] Bevy
+- [ ] Blue Engine
+- [ ] Macroquad
+- [ ] Fyrox
+- [ ] LogLogGames (comfy engine)
+- [ ] Spicy Lobster
+- [ ] Rust Godot
+
+Let us know if you also want to receive monthly reminders on your Discord server!
+
+## Publishing Steps
+
+- [ ] Final review - by everyone
+- [ ] Publish - by @janhohenheim
+- [ ] Post together with next calls for submissions - by @janhohenheim
+- [ ] Pin thread on social media - by @janhohenheim
+- [ ] Add comment links - by @janhohenheim
+
+## How to Contribute
+
+If you want to help writing the newsletter:
+
+- **Read [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z).**
+- Choose one or more of the "🆓 **free**" sections listed below, and leave a comment letting us know you want to work on them.
+  - The links in brackets (like `[1](#), [2](#), [3](#)`) are suggestions of links to include in the section. Feel free to add more!
+  - The username listed next to the section (like `@janhohenheim?`) is a suggestion of who may want to pick up the work (usually the project's developer, or someone who has expressed interest in the past).
+  - You are not obligated to write a section if you're tagged or your project is listed! You're welcome to ask someone else to write the section, or to ask for your project to be excluded from this month's post.
+  - Extra sections not listed in the plan are welcomed - just leave a comment and open a PR!
+- Write a short overview in the newsletter's Markdown file, making sure to follow the style guidelines (see below).
+- Send a PR [_to the `source` branch_](https://github.com/rust-gamedev/rust-gamedev.github.io/tree/source) (example PR: [N15: A/B Street #336](https://github.com/rust-gamedev/rust-gamedev.github.io/pull/336)).
+- Mention this issue in your PR's description to link it all together.
+
+## Style Guidelines
+
+The full style guide is in [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z),
+but here are the most important rules:
+
+- Write in third-person perspective.
+- Each line must be 160 characters or less, for ease of reviewing/diffing.
+- Only one image per section is allowed.
+  - The maximum size is 300kb for static images and 2.5mb for GIFs.
+  - The image should come before the text, and must have alt text for accessibility.
+  - Prefer static images to GIFs, to keep the page load times down.
+- Each section should be under 1000 characters, and under 6 paragraphs.
+  - This only applies to the rendered text, not the markup.
+- Keep formatting minimal - no bold/italics/etc.
+- Avoid long/nested bullet point lists - no changelogs!
+
+Please use these templates as a starting point:
+
+**Games/apps/libraries:**
+
+```md
+### [Game name]
+
+![alt text](img)
+_optional image label_
+
+[Game name] ([GitHub], [Discord], [Twitter]) by [@nickname]
+is... {short project description in one sentence}.
+
+{An overview of the recent updates with links to more details}.
+
+_Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
+
+[Game name]: http://example.com
+```
+
+**Articles/blog posts/videos/etc:**
+
+```md
+### [Article name]
+
+![alt text](img)
+_optional image label_
+
+[@nickname] published an [article] about...
+{overview what the resource is about}.
+
+_Discussions: [/r/rust_gamedev](link), [Twiter](link), [etc](link)_
+
+[Article name]: http://example.com
+```

newsletter-template.md renamed to .github/newsletter-template.md

@@ -1,15 +1,15 @@
 +++
-title = "This Month in Rust GameDev #{TODO} - {TODO} {TODO}"
+title = "This Month in Rust GameDev #{{ NEWSLETTER_COUNTER }} - {{ NEWSLETTER_MONTH }} {{ NEWSLETTER_YEAR }}"
 transparent = true
-date = TODO
+date = {{ NEWSLETTER_YEAR }}-{{ NEWSLETTER_NEXT_MONTH_NUMBER }}-03
 draft = true
 +++
 
 <!-- no toc -->
 
 <!-- Check the post with markdownlint-->
 
-Welcome to the {TODO}th issue of the Rust GameDev Workgroup's
+Welcome to the {{ NEWSLETTER_COUNTER }}th issue of the Rust GameDev Workgroup's
 monthly newsletter.
 [Rust] is a systems language pursuing the trifecta:
 safety, concurrency, and speed.
@@ -35,8 +35,8 @@ Feel free to send PRs about your own projects!
 - [Learning Material Updates](#learning-material-updates)
 - [Tooling Updates](#tooling-updates)
 - [Library Updates](#library-updates)
+- [Popular Workgroup Issues in GitHub](#popular-workgroup-issues-in-github)
 - [Other News](#other-news)
-- [Popular Workgroup Issues in Github](#popular-workgroup-issues-in-github)
 - [Meeting Minutes](#meeting-minutes)
 - [Discussions](#discussions)
 - [Requests for Contribution](#requests-for-contribution)
@@ -77,7 +77,7 @@ If needed, a section can be split into subsections with a "------" delimiter.
 
 ## Library Updates
 
-## Popular Workgroup Issues in Github
+## Popular Workgroup Issues in GitHub
 
 <!-- Up to 10 links to interesting issues -->
 
@@ -119,8 +119,10 @@ That's all news for today, thanks for reading!
 Want something mentioned in the next newsletter?
 [Send us a pull request][pr].
 
-Also, subscribe to [@rust_gamedev on Twitter][@rust_gamedev]
-or [/r/rust_gamedev subreddit][/r/rust_gamedev] if you want to receive fresh news!
+Also, subscribe to our socials if you want to receive fresh news!
+- X/Twitter: [@rust_gamedev][@x_rust_gamedev]
+- Mastodon: [@rust_gamedev][@mastodon_rust_gamedev]
+- Reddit: [/r/rust_gamedev][/r/rust_gamedev]
 
 <!--
 TODO: Add real links and un-comment once this post is published
@@ -132,4 +134,5 @@ TODO: Add real links and un-comment once this post is published
 -->
 
 [/r/rust_gamedev]: https://reddit.com/r/rust_gamedev
-[@rust_gamedev]: https://twitter.com/rust_gamedev
+[@x_rust_gamedev]: https://twitter.com/rust_gamedev
+[@mastodon_rust_gamedev]: https://mastodon.gamedev.place/@rust_gamedev

.github/workflows/ci.yml

@@ -15,16 +15,43 @@ jobs:
       # https://github.com/crazy-max/ghaction-github-pages/issues/1#issuecomment-623202206
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+      with:
+          fetch-depth: ${{ github.event_name == 'pull_request' && 2 || 0 }}
+    - name: Get changed files
+      id: changed-files
+      # source: https://stackoverflow.com/a/74268200, added filtering for markdown files
+      run: |
+        if ${{ github.event_name == 'pull_request' }}; then
+            changed_files=$(git diff --name-only -r HEAD^1 HEAD -z | grep '\.md$' -zZ | xargs -0)
+        else
+            changed_files=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }} -z | grep '\.md$' -zZ | xargs -0)
+        fi
+        echo "changed_files: $changed_files"
+        echo "changed_files=$changed_files" >> $GITHUB_OUTPUT
     - name: Lint
       uses: avto-dev/markdown-lint@v1
       with:
         args: '.'
         config: '.markdownlint.json'
+    - name: Check links
+      uses: lycheeverse/lychee-action@v1.9.0
+      if: ${{ steps.changed-files.outputs.changed_files != '' }}
+      with:
+        fail: true
+        args: >-
+          --verbose
+          --no-progress
+          --accept '100..=103,200..=299,300..=399'
+          --exclude '[^\w]todo[^\w]?'
+          --exclude 'https://(www\.|old\.)?reddit\.com'
+          ${{ steps.changed-files.outputs.changed_files }}
     - name: Install Zola
-      run: curl -L ${BASE_URL}/${VERS}/zola-${VERS}-${ARCH}.tar.gz | tar -xz
-    - run: ./zola --version
-    - run: ./zola build
+      run: |
+        curl -L ${BASE_URL}/${VERS}/zola-${VERS}-${ARCH}.tar.gz | tar -xz
+        echo "Zola version: $(./zola --version)"
+    - name: Zola build
+      run: ./zola build
     - name: Deploy
       if: github.ref == 'refs/heads/source'
       uses: crazy-max/ghaction-github-pages@v1

.github/workflows/create-newsletter.yaml

@@ -0,0 +1,45 @@
+name: Create Newsletter
+on:
+  schedule:
+    # Run on the 3rd of every month at 9 am
+    - cron: "0 9 3 * *"
+  workflow_dispatch:
+    inputs: {}
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+jobs:
+  create-newsletter:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: source
+      - name: Set environment variables
+        run: |
+          echo "NEWSLETTER_MONTH=$(date +'%B')" >> $GITHUB_ENV
+          echo "NEWSLETTER_NEXT_MONTH=$(date -d' 1 month ' +'%B')" >> $GITHUB_ENV
+          echo "NEWSLETTER_NEXT_MONTH_NUMBER=$(date -d' 1 month ' +'%m')" >> $GITHUB_ENV
+          echo "NEWSLETTER_YEAR=$(date +'%Y')" >> $GITHUB_ENV
+          # take the amount of months since feb 2024 and add 50
+          echo "NEWSLETTER_COUNTER=$(( ( ( $(date +'%Y') - 2024 ) * 12 + $(date +'%m') - 4 ) + 50 ))" >> $GITHUB_ENV
+      - name: Create newsletter scaffold
+        run: ./.github/create_newsletter_scaffold.sh
+      - name: Commit and create pull request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          commit-message: "Create newsletter N${{ env.NEWSLETTER_COUNTER }} for ${{ env.NEWSLETTER_MONTH }} ${{ env.NEWSLETTER_YEAR }}"
+          branch: "start-newsletter-${{ env.NEWSLETTER_COUNTER }}"
+          title: "Newsletter N${{ env.NEWSLETTER_COUNTER }} for ${{ env.NEWSLETTER_MONTH }} ${{ env.NEWSLETTER_YEAR }}"
+          body: "This PR adds the initial newsletter source file for ${{ env.NEWSLETTER_MONTH }} ${{ env.NEWSLETTER_YEAR }}."
+          assignees: |
+            AngelOnFira
+            janhohenheim
+            mamaicode
+      - name: Create tracking issue
+        uses: JasonEtco/create-an-issue@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/newsletter-issue-template.md

.markdownlint.json

@@ -1,12 +1,15 @@
 {
     "line-length": {
-        "line_length": 80,
+        "line_length": 160,
         "code_blocks": false
     },
-    "ul-style": {
-        "style": "dash"
-    },
-    "no-trailing-punctuation": {
-        "punctuation": ".,;:。，；："
-    }
-}
+    "blanks-around-lists": false,
+    "blanks-around-headings": false,
+    "no-multiple-blanks": false,
+    "no-trailing-spaces": false,
+    "no-trailing-punctuation": false,
+    "no-hard-tabs": false,
+    "hr-style": false,
+    "strong-style": false,
+    "emphasis-style": false
+}

config.toml

@@ -8,6 +8,7 @@ feed_filename = "rss.xml"
 
 [markdown]
 highlight_code = true
+smart_punctuation = true
 
 [extra]
 date_format = "%F"

content/blog/2019-08-18-introducing-the-rust-game-development-working-group.md

@@ -47,7 +47,7 @@ we've already got several projects underway:
 
 ## How can I get involved?
 
-Our main hub for co-ordination is our [Github repository](https://github.com/rust-gamedev/wg),
+Our main hub for co-ordination is our [GitHub repository](https://github.com/rust-gamedev/wg),
 where you can (and should!) raise issues calling out your ideas, proposals
 or problems with the Rust gamedev ecosystem.
 We also have a `#wg-gamedev` channel on the [official Rust Discord server](https://discord.gg/j6QJsMd),