User Command Prompt
Remember to change the GnollHack version in the following command prompt:
Please generate Steam patch notes for GnollHack 3.8. Use the process detailed in "Development/AI/Steam Patch Notes.md" in the GnollHackWiki repository.
(Note to AI agent: Skip the above text and proceed directly to the instructions below.)
Generating Patch Notes
Follow these instructions to generate patch notes for Steam:
- Check GitHub using the GitHub CLI (
gh) for the user-provided version. The GitHub version is usually in the format "GnollHack 4.3.0 Build 8". It can be a released version or an unreleased version tagged as a draft in GitHub. - GnollHack uses a dual versioning scheme. Steam releases are versioned as
X.Yand GitHub releases asGnollHack 4.X.0 Build Y. For example, version3.8in Steam maps to4.3.0 Build 8in GitHub. Map the version appropriately based on this scheme. - Read the list of changes in the release or tag in GitHub. It usually starts with something like "Build 8 makes the following changes:".
- Remove all changes that do not apply to the Windows version (for example, iOS or Android specific changes).
- Spell-check the patch notes and fix the grammar, if needed.
- Output the patch notes as two separate text blocks for the user to copy and paste to Steam: (1) The title text block, and (2) the body text block.
Text Block 1: Title Text
Format the title text for the Steam patch notes as follows:
Patch Notes, Version X.Y
Text Block 2: Body Text
Format the filtered list of changes using Steam's BBCode formatting as follows. Ensure that each line in the changes list ends in a period (add one if it is missing):
[h2]Changes[/h2]
[list]
[*] Change 1.
[*] Change 2.
[/list]