Skip to content

Commit

Permalink
Add GitHub Action for newsletter creation (#1464)
Browse files Browse the repository at this point in the history
* Add GitHub Action for newsletter tracking issue

* Restore newsletter template

* Create newsletter scaffold

* Refactor issue template

* Refactor issue action

* Incorporate feedback

* Add terminal newline

* Set target date
  • Loading branch information
janhohenheim authored Apr 9, 2024
1 parent 6d9db16 commit 7c7ea93
Show file tree
Hide file tree
Showing 4 changed files with 213 additions and 3 deletions.
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 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
```
38 changes: 38 additions & 0 deletions .github/workflows/create-newsletter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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
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 push changes
uses: EndBug/add-and-commit@v9
with:
message: "Create newsletter N${{ env.NEWSLETTER_COUNTER }} for ${{ env.NEWSLETTER_MONTH }} ${{ env.NEWSLETTER_YEAR }}"
push: "origin HEAD:source"
- name: Create tracking issue
uses: JasonEtco/create-an-issue@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
filename: .github/newsletter-issue-template.md

6 changes: 3 additions & 3 deletions 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 Down

0 comments on commit 7c7ea93

Please sign in to comment.