Skip to content

Add pull requests permission to create newsletter CI #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: source
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/create_newsletter_scaffold.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
#!/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_DEADLINE}" ]]; then
echo "NEWSLETTER_DEADLINE is not set. Exiting..."
exit 1
fi

if [[ -z "${NEWSLETTER_COUNTER}" ]]; then
echo "NEWSLETTER_COUNTER 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_DEADLINE\s*}}/${NEWSLETTER_DEADLINE}/g" index.md
sed -i "s/{{\s*NEWSLETTER_COUNTER\s*}}/${NEWSLETTER_COUNTER}/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
138 changes: 138 additions & 0 deletions .github/newsletter-issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
title: "Newsletter {{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}"
labels: coordination, help wanted
assignees: janhohenheim
---

###### tags: `newsletter`

**Editors:**

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 **03.{{ env.NEWSLETTER_DEADLINE }}**

We _may_ still accept PRs that are submitted later than this, as long as they're
ready before the newsletter's release, but this isn't guaranteed.
If you want your section to be included, don't leave it till the last minute!

## 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

- TODO

### Learning Material Updates

- TODO

### Engine Updates

- TODO

### Tooling Updates

- TODO

### Library Updates

- TODO

### Other News

- TODO

### Discussions

- TODO

## Publishing Steps

- [ ] Final review - by everyone
- [ ] Publish - by @janhohenheim
- [ ] Post on /r/rust, /r/rust_gamedev, /r/gamedev, URLO - by @janhohenheim
- [ ] Pin thread on Twitter - by @AngelOnFira
- [ ] Add comment links - by @AngelOnFira

## 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_ (example: [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 80 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
```
10 changes: 5 additions & 5 deletions newsletter-template.md → .github/newsletter-template.md
Original file line number Diff line number Diff line change
@@ -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_DEADLINE }}
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.
Expand All @@ -36,7 +36,7 @@ Feel free to send PRs about your own projects!
- [Tooling Updates](#tooling-updates)
- [Library Updates](#library-updates)
- [Other News](#other-news)
- [Popular Workgroup Issues in Github](#popular-workgroup-issues-in-github)
- [Popular Workgroup Issues in GitHub](#popular-workgroup-issues-in-github)
- [Meeting Minutes](#meeting-minutes)
- [Discussions](#discussions)
- [Requests for Contribution](#requests-for-contribution)
Expand Down Expand Up @@ -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 -->

Expand Down
44 changes: 44 additions & 0 deletions .github/workflows/create-newsletter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Create Newsletter
on:
schedule:
# Run on the 5th of every month at 12pm
- cron: "0 12 5 * *"
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_YEAR=$(date +'%Y')" >> $GITHUB_ENV
echo "NEWSLETTER_DEADLINE=$(date -d' 1 month ' '+%m.%Y')" >> $GITHUB_ENV
# take the amount of months since feb 2024 and add 50
echo "NEWSLETTER_COUNTER=$(( ( ( $(date +'%Y') - 2024 ) * 12 + $(date +'%m') - 2 ) + 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
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/blog/rust-gamedev-meetup-33/bones.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/blog/rust-gamedev-meetup-33/galaxion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 84 additions & 0 deletions content/blog/rust-gamedev-meetup-33/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
+++
title = "Rust Gamedev Meetup 33"
date = 2023-12-09
transparent = true
aliases = ["posts/gamedev-meetup-33"]
+++

<!-- markdownlint-disable single-title heading-increment -->
<!-- markdownlint-disable no-blanks-blockquote no-emphasis-as-header -->
<!-- markdownlint-configure-file {"line-length": {"heading_line_length": 120}} -->

![Rust Gamedev Meetup](gamedev-meetup.png)

The 33rd Rust Gamedev Meetup took place on December 9th. You can watch the
recording of the meetup [here on YouTube][meetup-video]. The meetup took
place on the Rust Gamedev [YouTube][youtube-stream] and [Twitch][twitch-stream].
The meetups take place on the second Saturday of every month via the [Rust
Gamedev Discord server][rust-gamedev-discord] and are also [streamed on
Twitch][rust-gamedev-twitch].

[rust-gamedev-discord]: https://discord.gg/yNtPTb2
[rust-gamedev-twitch]: https://twitch.tv/rustgamedev
[meetup-video]: https://www.youtube.com/watch?v=eItRSKJGV1I
[youtube-stream]: https://www.youtube.com/@RustGameDevelopment
[twitch-stream]: https://www.twitch.tv/RustGameDev

## Talks

### [Blue Engine][blue-engine-video] | [@ElhamAryanpur]

[![Blue Engine](blue-engine.png)][blue-engine-video]

> Updates about community work for the Blue Engine, as well as future engine
> features coming up.

**Links:**

- [Blue Engine GitHub repository]
- [Blue Engine Discord server]

[@ElhamAryanpur]: https://github.com/ElhamAryanpur
[blue-engine-video]: https://www.youtube.com/watch?v=7u9YrBOnTww
[Blue Engine GitHub repository]: https://github.com/AryanpurTech/BlueEngine
[Blue Engine Discord server]: https://discord.gg/s7xsj9q

### [Galaxion Trade Wars][galaxion-trade-wars-video] | [@Syn-Nine]

[![Galaxion Trade Wars](galaxion.png)][galaxion-trade-wars-video]

> Space Trading Game made in Rust based on the Trade Wars 2002 BBS game.

**Links:**

- [Galaxion Trade Wars GitHub repository]
- [Syn-Nine Twitter]
- [Syn-Nine Website]

[@Syn-Nine]: https://github.com/Syn-Nine
[galaxion-trade-wars-video]: https://www.youtube.com/watch?v=oNx5wqAsvXM
[Galaxion Trade Wars GitHub repository]: https://github.com/Syn-Nine/galaxion-trade-empire/
[Syn-Nine Twitter]: https://twitter.com/Syn9Dev
[Syn-Nine Website]: https://syn9.thehideoutgames.com/

### [Bones Engine][bones-engine-video] | [@zicklag]

[![Bones Engine](bones.png)][bones-engine-video]

> A 'meta-engine' framework made to facilitate the development of moddable,
> multiplayer 2D games.

**Links:**

- [@zicklag]
- [Bone Engine GitHub repository]
- [Jumpy GitHub repository]
- [Jumpy's Migration to the Bones Framework]
- [Introducing Lua Scripting in Jumpy]

[@zicklag]: https://github.com/zicklag
[bones-engine-video]: https://www.youtube.com/watch?v=bEyZubAx_oM
[Bone Engine GitHub repository]: https://github.com/fishfolk/bones
[Jumpy GitHub repository]: https://github.com/fishfolk/jumpy
[Jumpy's Migration to the Bones Framework]: https://fishfolk.org/blog/jumpy-migration-to-bones-framework/
[Introducing Lua Scripting in Jumpy]: https://fishfolk.org/blog/introducing-lua-scripting-in-jumpy/
2 changes: 1 addition & 1 deletion content/news/001/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ Special section for other news (up to 15) in a one-liner format:
[Alex Butler]: https://twitter.com/bigabgames
[roboinstructus 1.0]: https://reddit.com/r/rust/comments/cdw1ct/robo_instructus_is_out_now_programming_puzzle

## Popular Workgroup Issues in Github
## Popular Workgroup Issues in GitHub

<!-- Up to 10 links to interesting issues -->

Expand Down
8 changes: 4 additions & 4 deletions content/news/002/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,11 +461,11 @@ _Discussions:

![Live2D Piston demo](live2d-cubism.png)

- ["Github Actions CI with Rust and SDL2"] -
- ["GitHub Actions CI with Rust and SDL2"] -
[Alexandru Ene] wrote a post about CI with [github actions]
for [their hobby game project][after-hours] that uses Rust and SDL2.

![Github Actions with SDL2 screencast demo](github_actions_ci.gif)
![GitHub Actions with SDL2 screencast demo](github_actions_ci.gif)

- [@phaazon] released [luminance] 0.33 that
[brings geometry instancing support](https://reddit.com/r/rust/comments/d0us73/announcement_luminance033);
Expand Down Expand Up @@ -527,7 +527,7 @@ but I'm too tired to this atm and it will be rendered correctly anyway.
-->

[Alexandru Ene]: https://twitter.com/_AlexEne_
["Github Actions CI with Rust and SDL2"]: https://alexene.dev/2019/09/04/Github-actions-CI-rust-SDL2.html
["GitHub Actions CI with Rust and SDL2"]: https://alexene.dev/2019/09/04/Github-actions-CI-rust-SDL2.html
[github actions]: https://github.com/features/actions
[after-hours]: https://alexene.dev/2019/01/15/After-hours-game-development.html
[Xprite]: https://pickitup247.com/xprite.html
Expand Down Expand Up @@ -568,7 +568,7 @@ but I'm too tired to this atm and it will be rendered correctly anyway.
[imgui-inspect]: https://github.com/aclysma/imgui-inspect
[minimum]: https://github.com/aclysma/minimum

## Popular Workgroup Issues in Github
## Popular Workgroup Issues in GitHub

<!-- Up to 10 links to interesting issues -->

Expand Down
2 changes: 1 addition & 1 deletion content/news/003/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -793,7 +793,7 @@ _Discussions:
[Amethyst organization]: https://github.com/amethyst
[@_AndreaCatania]: https://twitter.com/_AndreaCatania

## Popular Workgroup Issues in Github
## Popular Workgroup Issues in GitHub

<!-- Up to 10 links to interesting issues -->

Expand Down
Loading
Loading