Gittes-archive/ow-mod-man
2
0
Fork 0
mirror of https://github.com/ow-mods/ow-mod-man.git synced 2025-12-11 20:15:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Ben C 2023-07-20 14:19:51 -04:00 committed by GitHub
parent 05200c9096
commit 55d02581dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -7,31 +7,31 @@ Each package has different prerequisites for compiling/building, please look at
When performing changes on a specific package, try to prefix the name with the package you're changing, see below:
- For the core package: `[CORE] Made changes to core`
- For the cli package: `[CLI] Made changes to the CLI`
- For the gui package: `[GUI] Made changes to the GUI`
- For the CLI package: `[CLI] Made changes to the CLI`
- For the GUI package: `[GUI] Made changes to the GUI`
- For multiple packages: `[CORE/GUI] Made changes to both the core and GUI`
- For all packages: `[ALL] Made changes to everything`
- For chores such as updating deps: `[CHORE] Update Deps`
- For meta-related changes such as editing actions or updating READMEs: `[META] Changed CD/CI pipeline`
Also try to tag issues and PRs with the appropriate tags.
Also, could you try to tag issues and PRs with the appropriate tags?
## Creating Releases
I tried to automate this process in a way that makes sense but it still needs some manual input
1. **Ensure all versions a up to date** Make sure these are bumped to the versions
1. **Ensure all versions are up to date** Make sure these are bumped to the versions
1. `owmods_core/Cargo.toml`
2. `owmods_cli/Cargo.toml` - **also update the reference to owmods_core if it was updated**
3. `owmods_gui/backend/Cargo.toml` - **also update the reference to owmods_core if it was updated**
4. `xtask/Cargo.toml` - not the end of the world if you don't update thi,s just determines the version shown in man files for the CLI
4. `xtask/Cargo.toml` - not the end of the world, if you don't update this, determines the version shown in man files for the CLI
5. `owmods_gui/backend/tauri.conf.json` - **PLEASE UPDATE THIS ALONG WITH THE GUI, IT'S WHAT MAKES THE UPDATER WORK!**
2. Merge `dev` to `main` (assuming you have a PR going)
3. Run the "Create Core Release" action
4. After the action completes go to Releases and fill out the draft release with the core's changelog, **do not set this as latest release**, then publish
4. After the action completes go to Releases and fill out the draft release with the core's changelog, **do not set this as the latest release**, then publish
5. Then another action will run once you publish the release, wait for that to finish
6. Now you can run both the Release CLI and Release GUI workflows, the CLI will probably finish first
7. After the CLI finishes, go to releases and fill out the draft release, **do not set this as latest release**, then publish
8. After the GUI finished, go to releases and fill out the draft release, **set this as latest**, then publish
7. After the CLI finishes, go to releases and fill out the draft release, **do not set this as the latest release**, then publish
8. After the GUI is finished, go to releases and fill out the draft release, **set this as latest**, then publish
9. An action will run after each release, they don't require any further input
10. Finally, [the flatpak repo](https://github.com/flathub/com.outerwildsmods.owmods_gui) should automatically create a PR for updating after about an hour, sadly because of how flathub is setup you can't merge this! @ me on discord and I'll handle it.
10. Finally, [the flatpak repo](https://github.com/flathub/com.outerwildsmods.owmods_gui) should automatically create a PR for updating after about an hour. Only certain people have access to the repo and can merge, so if you don't, @ me on Discord and I'll handle it.