gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-20 18:22:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update release instructions

Browse Source
This commit is contained in:
ISSOtm
2024-09-18 16:47:10 +02:00
parent dd20012e88
commit deb3ac3452
2 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/create-release-artifacts.yml vendored
View File

@@ -89,7 +89,7 @@ jobs:
strip rgb{asm,link,fix,gfx} strip rgb{asm,link,fix,gfx}
- name: Package binaries - name: Package binaries
run: | run: |
zip --junk-paths rgbds-${{ env.version }}-macos-x86_64.zip rgb{asm,link,fix,gfx} man/* .github/scripts/install.sh zip --junk-paths rgbds-${{ env.version }}-macos.zip rgb{asm,link,fix,gfx} man/* .github/scripts/install.sh
- name: Upload macOS binaries - name: Upload macOS binaries
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
with: with:
@@ -149,7 +149,7 @@ jobs:
files: | files: |
win32/rgbds-${{ env.version }}-win32.zip win32/rgbds-${{ env.version }}-win32.zip
win64/rgbds-${{ env.version }}-win64.zip win64/rgbds-${{ env.version }}-win64.zip
macos/rgbds-${{ env.version }}-macos-x86_64.zip macos/rgbds-${{ env.version }}-macos.zip
linux/rgbds-${{ env.version }}-linux-x86_64.tar.xz linux/rgbds-${{ env.version }}-linux-x86_64.tar.xz
rgbds-${{ env.version }}.tar.gz rgbds-${{ env.version }}.tar.gz
fail_on_unmatched_files: true fail_on_unmatched_files: true

5
RELEASE.md
View File

@@ -38,8 +38,7 @@ GitHub.
4. GitHub Actions will run the [create-release-docs.yml](.github/workflows/create-release-docs.yml) 4. GitHub Actions will run the [create-release-docs.yml](.github/workflows/create-release-docs.yml)
workflow to add the release documentation to [rgbds-www](https://github.com/gbdev/rgbds-www). workflow to add the release documentation to [rgbds-www](https://github.com/gbdev/rgbds-www).
For a release candidate, which creates a prerelease, you will have to This is not done automatically for prereleases; if you want to do this manually,
take these steps yourself.
1. Clone [rgbds-www](https://github.com/gbdev/rgbds-www). You can use 1. Clone [rgbds-www](https://github.com/gbdev/rgbds-www). You can use
`git clone https://github.com/gbdev/rgbds-www.git`. `git clone https://github.com/gbdev/rgbds-www.git`.
@@ -47,7 +46,7 @@ GitHub.
2. Make sure that you have installed `groff` and `mandoc`. You will 2. Make sure that you have installed `groff` and `mandoc`. You will
need `mandoc` 1.14.5 or later to support `-O toc`. need `mandoc` 1.14.5 or later to support `-O toc`.
3. Run <code>.github/actions/get-pages.sh -r <i>&lt;path/to/rgbds-www&gt;</i> <i>&lt;tag&gt;</i></code>. 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>.
This will render the RGBDS documentation as HTML and PDF and copy it to This will render the RGBDS documentation as HTML and PDF and copy it to
`rgbds-www`. `rgbds-www`.