Skip to content

Commit deb3ac3

Browse files
committed
Update release instructions
1 parent dd20012 commit deb3ac3

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

.github/workflows/create-release-artifacts.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ jobs:
8989
strip rgb{asm,link,fix,gfx}
9090
- name: Package binaries
9191
run: |
92-
zip --junk-paths rgbds-${{ env.version }}-macos-x86_64.zip rgb{asm,link,fix,gfx} man/* .github/scripts/install.sh
92+
zip --junk-paths rgbds-${{ env.version }}-macos.zip rgb{asm,link,fix,gfx} man/* .github/scripts/install.sh
9393
- name: Upload macOS binaries
9494
uses: actions/upload-artifact@v4
9595
with:
@@ -149,7 +149,7 @@ jobs:
149149
files: |
150150
win32/rgbds-${{ env.version }}-win32.zip
151151
win64/rgbds-${{ env.version }}-win64.zip
152-
macos/rgbds-${{ env.version }}-macos-x86_64.zip
152+
macos/rgbds-${{ env.version }}-macos.zip
153153
linux/rgbds-${{ env.version }}-linux-x86_64.tar.xz
154154
rgbds-${{ env.version }}.tar.gz
155155
fail_on_unmatched_files: true

RELEASE.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,15 @@ GitHub.
3838
4. GitHub Actions will run the [create-release-docs.yml](.github/workflows/create-release-docs.yml)
3939
workflow to add the release documentation to [rgbds-www](https://github.com/gbdev/rgbds-www).
4040

41-
For a release candidate, which creates a prerelease, you will have to
42-
take these steps yourself.
41+
This is not done automatically for prereleases; if you want to do this manually,
4342

4443
1. Clone [rgbds-www](https://github.com/gbdev/rgbds-www). You can use
4544
`git clone https://github.com/gbdev/rgbds-www.git`.
4645

4746
2. Make sure that you have installed `groff` and `mandoc`. You will
4847
need `mandoc` 1.14.5 or later to support `-O toc`.
4948

50-
3. Run <code>.github/actions/get-pages.sh -r <i>&lt;path/to/rgbds-www&gt;</i> <i>&lt;tag&gt;</i></code>.
49+
3. Inside of the `man` directory, run <code><i>&lt;path/to/rgbds-www&gt;</i>/maintainer/man_to_html.sh <i>&lt;tag&gt;</i> *</code> then <code><i>&lt;path/to/rgbds-www&gt;</i>/maintainer/new_release.sh <i>&lt;tag&gt;</i></code>.
5150
This will render the RGBDS documentation as HTML and PDF and copy it to
5251
`rgbds-www`.
5352

0 commit comments

Comments
 (0)