Skip to content
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

Improve newsletter create action #1472

Merged
Merged
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
6 changes: 0 additions & 6 deletions .github/create_newsletter_scaffold.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@ if [[ -z "${NEWSLETTER_YEAR}" ]]; then
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
Expand All @@ -25,7 +20,6 @@ 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})"
Expand Down
42 changes: 15 additions & 27 deletions .github/newsletter-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,15 @@ newsletter with {{ env.NEWSLETTER_MONTH }}'s news!

## Current Schedule

The deadline for all section PRs is the **03.{{ env.NEWSLETTER_DEADLINE }}**
The deadline for all section PRs is the **3rd of {{ env.NEWSLETTER_NEXT_MONTH}}, {{ env.NEWSLETTER_YEAR }}**

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!
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).
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!
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

Expand Down Expand Up @@ -57,31 +53,23 @@ to write about, just make a comment on this issue and open a PR!

## 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
- [ ] 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).
- 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.

Expand Down
4 changes: 2 additions & 2 deletions .github/newsletter-template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "This Month in Rust GameDev #{{ NEWSLETTER_COUNTER }} - {{ NEWSLETTER_MONTH }} {{ NEWSLETTER_YEAR }}"
transparent = true
date = {{ NEWSLETTER_DEADLINE }}
date = {{ NEWSLETTER_YEAR }}-{{ NEWSLETTER_NEXT_MONTH_NUMBER }}-03
draft = true
+++

Expand Down Expand Up @@ -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)
- [Other News](#other-news)
- [Popular Workgroup Issues in GitHub](#popular-workgroup-issues-in-github)
- [Other News](#other-news)
- [Meeting Minutes](#meeting-minutes)
- [Discussions](#discussions)
- [Requests for Contribution](#requests-for-contribution)
Expand Down
11 changes: 6 additions & 5 deletions .github/workflows/create-newsletter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ jobs:
- 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
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
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
Expand All @@ -33,9 +34,9 @@ jobs:
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
AngelOnFira
janhohenheim
mamaicode
- name: Create tracking issue
uses: JasonEtco/create-an-issue@v2
env:
Expand Down
Loading