Skip to content

Commit 9d729f1

Browse files
committed
Add GitHub Action for newsletter tracking issue
1 parent 4b9a38f commit 9d729f1

File tree

3 files changed

+166
-135
lines changed

3 files changed

+166
-135
lines changed

.github/newsletter-template.md

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
title: "N{{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}"
3+
labels: coordination, help wanted
4+
---
5+
6+
# Newsletter {{ env.NEWSLETTER_COUNTER}}: {{ env.NEWSLETTER_MONTH }} {{ env.NEWSLETTER_YEAR }}
7+
8+
###### tags: `newsletter`
9+
10+
**Editors:**
11+
12+
Another month has gone by, so it's time to put together the Rust Gamedev newsletter with {{ env.NEWSLETTER_MONTH }}'s news!
13+
14+
## Current Schedule
15+
16+
**The deadline for all section PRs is the 03.{{ env.NEWSLETTER_DEADLINE }}**
17+
18+
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!
19+
20+
## Current Structure & Status
21+
22+
Below is our current planned structure for the newsletter, and the status of each PR (which we'll try to keep updated).
23+
24+
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!
25+
26+
#### Rust Gamedev Meetup
27+
28+
* [ ] Details of this month's meetup - 🆓 **free** (@AngelOnFira @ozkriff?)
29+
30+
#### Game Updates
31+
32+
#### Learning Material Updates
33+
34+
#### Engine Updates
35+
36+
#### Tooling Updates
37+
38+
#### Library Updates
39+
40+
#### Other News
41+
42+
* [ ] Bullet points of any interesting news that doesn't have its own section - by @ozkrif
43+
44+
#### Discussions
45+
46+
## Publishing Steps
47+
48+
* [ ] Final review - by everyone
49+
50+
* [ ] Publish - by @ozkriff
51+
52+
* [ ] Post on /r/rust, /r/rust_gamedev, /r/gamedev, URLO, twitter.com/rust_gamedev - by @ozkriff
53+
54+
* [ ] Pin thread on Twitter - by @ozkriff
55+
56+
* [ ] Add comment links - by @ozkriff
57+
58+
* [ ] Add a draft of next month's newsletter - by @ozkriff
59+
60+
## How to Contribute
61+
62+
If you want to help writing the newsletter:
63+
64+
* **Read [CONTRIBUTING.md](https://github.com/rust-gamedev/rust-gamedev.github.io/blob/source/CONTRIBUTING.md?rgh-link-date=2023-09-12T16%3A17%3A34Z).**
65+
66+
* Choose one or more of the "🆓 **free**" sections listed below, and leave a comment letting us know you want to work on them.
67+
68+
* The links in brackets (like "[1](#), [2](#), [3](#)") are suggestions of links to include in the section. Feel free to add more!
69+
* The username listed next to the section (like "@ozkriff?") 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).
70+
* 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.
71+
* Extra sections not listed in the plan are welcomed - just leave a comment and open a PR!
72+
73+
* Write a short overview in the newsletter's Markdown file, making sure to follow the style guidelines (see below).
74+
75+
* Send a PR _to the `source` branch_ (example: [N15: A/B Street #336](https://github.com/rust-gamedev/rust-gamedev.github.io/pull/336)).
76+
77+
* Mention this issue in your PR's description to link it all together.
78+
79+
## Style Guidelines
80+
81+
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:
82+
83+
* Write in third-person perspective.
84+
85+
* Each line must be 80 characters or less, for ease of reviewing/diffing.
86+
87+
* Only one image per section is allowed.
88+
89+
* The maximum size is 300kb for static images and 2.5mb for GIFs.
90+
* The image should come before the text, and must have alt text for accessibility.
91+
* Prefer static images to GIFs, to keep the page load times down.
92+
93+
* Each section should be under 1000 characters, and under 6 paragraphs.
94+
95+
* This only applies to the rendered text, not the markup.
96+
97+
* Keep formatting minimal - no bold/italics/etc.
98+
99+
* Avoid long/nested bullet point lists - no changelogs!
100+
101+
Please use these templates as a starting point:
102+
103+
**Games/apps/libraries:**
104+
105+
```
106+
### [Game name]
107+
108+
![alt text](img)
109+
_optional image label_
110+
111+
[Game name] ([GitHub], [Discord], [Twitter]) by [@nickname]
112+
is... {short project description in one sentence}.
113+
114+
{An overview of the recent updates with links to more details}.
115+
116+
_Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
117+
118+
[Game name]: http://example.com
119+
```
120+
121+
**Articles/blog posts/videos/etc:**
122+
123+
```
124+
### [Article name]
125+
126+
![alt text](img)
127+
_optional image label_
128+
129+
[@nickname] published an [article] about...
130+
{overview what the resource is about}.
131+
132+
_Discussions: [/r/rust_gamedev](link), [Twiter](link), [etc](link)_
133+
134+
[Article name]: http://example.com
135+
```
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Create Newsletter Tracking Issue
2+
on:
3+
schedule:
4+
# Run on the 5th of every month at 12pm
5+
- cron: "0 12 5 * *"
6+
workflow_dispatch:
7+
inputs: {}
8+
permissions:
9+
contents: read
10+
issues: write
11+
jobs:
12+
create-newsletter:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
- name: Set newsletter month
17+
run: echo "NEWSLETTER_MONTH=$(date +'%B')" >> $GITHUB_ENV
18+
- name: Set newsletter year
19+
run: echo "NEWSLETTER_YEAR=$(date +'%Y')" >> $GITHUB_ENV
20+
- name: Set newsletter deadline
21+
run: echo "NEWSLETTER_DEADLINE=$(date -d' 1 month ' '+%m.%Y')" >> $GITHUB_ENV
22+
- name: Set newsletter counter
23+
# take the amount of months since feb 2024 and add 50
24+
run: echo "NEWSLETTER_COUNTER=$(( ( ( $(date +'%Y') - 2024 ) * 12 + $(date +'%m') - 2 ) + 50 ))" >> $GITHUB_ENV
25+
- name: Create tracking issue
26+
uses: JasonEtco/create-an-issue@v2
27+
env:
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29+
with:
30+
filename: .github/newsletter-template.md
31+

newsletter-template.md

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)