Skip to content

Free games for graphing calculators: NumWorks, TI-Nspire CX, Casio fx-CG50 and soon TI-84 Plus CE. Balatro, Celeste, Hollow Knight, Minecraft and more.

Releases: what's new in each version, in CHANGELOG.md and at the top of the release

Mason3631df5641feba7
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index ceaf6556..cc381f4c 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -114,9 +114,10 @@ jobs:
echo "$tag is already released"
exit 0
fi
- python3 tools/release.py --tag "$tag" --notes build/data/release-notes.md --build build/compiled > build/data/release-files.txt
+ python3 tools/release.py --tag "$tag" --notes build/data/release-notes.md --title build/data/release-title.txt \
+ --build build/compiled > build/data/release-files.txt
mapfile -t files < build/data/release-files.txt
gh release create "$tag" "${files[@]}" --target "$GITHUB_SHA" \
- --title "NumPlay $tag" --notes-file build/data/release-notes.md
+ --title "$(cat build/data/release-title.txt)" --notes-file build/data/release-notes.md
# the README's version and downloads badges come from the site (docs/badges): deploy it again
gh workflow run pages.yml --ref main || echo "(the site was not deployed again)"
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..8a9d5458
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,46 @@
+# Changelog
+
+What's new in each version of NumPlay. Every file of every version is on the [downloads page](https://github.com/Mason363/NumPlay/releases).
+
+## 1.15.0: Stickman Hook, Donkey Kong, Core Ball, Dune and NumPlay Studio
+
+- **New in NumPlay:** Core Ball, after Tower Blocks.
+- **New on their own:** Stickman Hook, Donkey Kong and Dune.
+- **NumPlay Studio:** a website where you pick the games in your NumPlay, add your own Game Boy, NES and Sega games, and install it.
+- **Fixed:** Hollow Knight's Charms page says to rest at a bench, Home keeps a charm you just put on, and the stag stations are no longer black.
+- The four new games were brought to NumPlay by Bobydeluxe. The Upsilon version has 24 games.
+
+## 1.14.0: Suika Game, Flappy Dunk, Tower Blocks, Doodle Jump and Jetpack Joyride
+
+- **New in NumPlay:** Suika Game, Flappy Dunk, Tower Blocks and Doodle Jump, all four by Bobydeluxe.
+- **New on its own:** Jetpack Joyride.
+- **Fixed:** Subway Surfers' side tracks no longer vanish, Champion Island's last two side quests, Doom's far floors no longer shimmer, and the air hockey puck can't get stuck.
+- The Upsilon version has 23 games.
+
+## 1.13.0: nine big games, five new ones in NumPlay
+
+- **New on their own:** Subway Surfers, Five Nights at Freddy's, Doom, The Binding of Isaac, Hill Climb Racing, Plants vs. Zombies, Sonic the Hedgehog, Cookie Clicker and Level Devil.
+- **New in NumPlay:** 2 Players, Space Invaders, Sudoku, Ultimate Tic-Tac-Toe and Sokoban.
+- NumVisuals moves out to an app of its own. Its backgrounds stay in NumPlay.
+- **Fixed:** your bug lists for NumBlocks, Doom, Hollow Knight, Undertale, Celeste, NumDrive and Champion Island.
+
+## 1.12.0: Chrome Dino
+
+- **New in NumPlay:** Chrome Dino, after Tetris, brought to NumPlay by LilyTheCatgirl.
+
+## 1.11.2: Celeste's Summit checkpoints, NumDrive faster and fixed levels
+
+- **Fixed:** every checkpoint in Celeste's 7B works again. NumDrive is faster, its shadows stay put, and nine of its levels play as they should.
+
+## 1.11.1: 46 KB smaller
+
+- NumPlay takes 46 KB less space on the calculator. Every game plays and looks as before.
+
+## 1.11.0: Undertale
+
+- **New on its own:** Undertale, the whole Underground to the neutral ending.
+- **Fixed:** Tetris' Up is harder to press by accident, and On/Off saves and quits NumBlocks.
+
+## 1.10.0: Block Blast
+
+- **New in NumPlay:** Block Blast, after Buckshot Roulette.
diff --git a/README.md b/README.md
index 70b1da8c..cb89833a 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
</p>
<p align="center">
- <a href="#how-to-install"><b>How to install</b></a> &nbsp;·&nbsp; <a href="docs/play.md"><b>How to play</b></a> &nbsp;·&nbsp; <a href="https://github.com/Mason363/NumPlay/releases/latest"><b>All downloads</b></a> &nbsp;·&nbsp; <a href="#roadmap"><b>Roadmap</b></a> &nbsp;·&nbsp; <a href="docs/make-a-game.md"><b>Make a game</b></a>
+ <a href="#how-to-install"><b>How to install</b></a> &nbsp;·&nbsp; <a href="docs/play.md"><b>How to play</b></a> &nbsp;·&nbsp; <a href="https://github.com/Mason363/NumPlay/releases/latest"><b>All downloads</b></a> &nbsp;·&nbsp; <a href="CHANGELOG.md"><b>What's new</b></a> &nbsp;·&nbsp; <a href="#roadmap"><b>Roadmap</b></a> &nbsp;·&nbsp; <a href="docs/make-a-game.md"><b>Make a game</b></a>
</p>
<p align="center">
diff --git a/tools/release.py b/tools/release.py
index cc093acc..942d5f21 100644
--- a/tools/release.py
+++ b/tools/release.py
@@ -6,11 +6,14 @@ them, so the notes carry the list in a useful order (NumPlay first, then its
discreet versions, then each game on its own in the launcher's order) with a
link to each file, and every file gets a label saying what it is.
-- --notes FILE: writes the notes, .github/release.md (the introduction) and
- then the list;
+- --notes FILE: writes the notes, .github/release.md (the introduction), what's new in
+ this version (its section of CHANGELOG.md) and then the list;
+- --title FILE: writes the release's title, "NumPlay v1.3.0: " and the heading of
+ its section of CHANGELOG.md;
- prints one `path#label` per line, the arguments of `gh release create`.
-Usage: release.py --tag v1.3.0 --notes build/data/release-notes.md --build build/compiled
+Usage: release.py --tag v1.3.0 --notes build/data/release-notes.md --title build/data/release-title.txt
+ --build build/compiled
"""
import argparse
import json
@@ -67,10 +70,33 @@ def standalone_names():
return names
+def changes(version):
+ """(the heading, the lines) of this version's section of CHANGELOG.md: "## 1.3.0: heading" and what's under it"""
+ path = os.path.join(ROOT, "CHANGELOG.md")
+ if not os.path.exists(path):
+ return None, []
+ heading, lines = None, []
+ for line in open(path).read().splitlines():
+ if line.startswith("## "):
+ if heading is not None:
+ break
+ v, _, rest = line[3:].partition(":")
+ if v.strip() == version:
+ heading = rest.strip()
+ elif heading is not None:
+ lines.append(line)
+ while lines and not lines[-1].strip():
+ lines.pop()
+ while lines and not lines[0].strip():
+ lines.pop(0)
+ return heading, lines
+
+
def main():
ap = argparse.ArgumentParser()
ap.add_argument("--tag", required=True)
ap.add_argument("--notes", required=True)
+ ap.add_argument("--title", help="where to write the release's title")
ap.add_argument("--build", default="build/compiled")
a = ap.parse_args()
# (a game the default NumPlay.nwa leaves out, "default": false, comes from the customizer website)
@@ -119,8 +145,14 @@ def main():
notes += ["", "<sub>The file list below is sorted A to Z by GitHub. Each file's label says what it is.</sub>"]
intro = open(os.path.join(ROOT, ".github", "release.md")).read().rstrip()
+ heading, new = changes(a.tag.lstrip("v"))
+ if new:
+ intro += "\n\n### What's new\n\n" + "\n".join(new)
with open(a.notes, "w") as f:
f.write(intro + "\n\n" + "\n".join(notes) + "\n")
+ if a.title:
+ with open(a.title, "w") as f:
+ f.write(f"NumPlay {a.tag}" + (f": {heading}" if heading else "") + "\n")
for path, label in files:
if not os.path.exists(path):
raise SystemExit(f"release: missing {path}")