andrew
/
perfin
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Activity

Added release procedure to readme.

This commit is contained in:
Andrew Lalis 2024-01-04 21:52:53 -05:00
parent ceddc49adf
commit bde5185ea6
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -24,3 +24,17 @@ assured that your data remains completely private.
Currently, the application is still a work-in-progress, and is not yet suitable Currently, the application is still a work-in-progress, and is not yet suitable
for actual usage with your real financial data, so stay tuned for updates. for actual usage with your real financial data, so stay tuned for updates.
# Release Procedure
Platform-specific package installers are generated automatically via GitHub
Actions (see `.github/workflows/make-release.yaml`), which is triggered by a
new tag being pushed to the `main` branch. Follow these steps to push a release:
1. Run `java scripts/SetVersion.java 1.2.3` (replacing `1.2.3` with the new version number)
to set the version everywhere that it needs to be.
2. Add a tag to the `main` branch with `git tag v1.2.3`.
3. Push the tag to GitHub with `git push origin v1.2.3`.
Once that's done, the workflow will start, and you should see a release appear
in the next few minutes.