Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document DLL updates #893

Merged
merged 2 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@
* in `variables.nsh` update both blocks immediately and swap the comments
* in `ultrastardx.appdata.xml` add a new entry
* in `Info.plist` update the version number
3. Commit, `git tag v<the-new-version>` and then `git push origin master v<the-new-version> master:release`
4. Wait and get the artifacts from the CI.
3. If there are pre-releases in [mxe releases](https://github.com/UltraStar-Deluxe/mxe/releases), see [UPDATING-DLLS.md](UPDATING-DLLS.md).
4. Commit, `git tag v<the-new-version>` and then `git push origin master v<the-new-version> master:release`
5. Wait and get the artifacts from the CI.
If any of them fail, just add an extra `;` on one of the already commented lines in `variables.nsh`, commit, and then push only `master`.
5. Add `+dev` to the version in the first two files and swap the comments in `variables.nsh` again, commit, push.
6. Add `+dev` to the version in the first two files and swap the comments in `variables.nsh` again, commit, push.
This is just to set the dev version again.
6. Attach the artifacts to the release page and publish it.
7. Attach the artifacts to the release page and publish it.
Don't forget to also create a PR for this release in
https://github.com/UltraStar-Deluxe/ultrastar-deluxe.github.io
7. Create a PR in [the FlatHub repository](https://github.com/flathub/eu.usdx.UltraStarDeluxe) that updates the tag and commit values
See this PR for an example: https://github.com/flathub/eu.usdx.UltraStarDeluxe/pull/7/files
8. Create a PR in [the FlatHub repository](https://github.com/flathub/eu.usdx.UltraStarDeluxe) that updates the tag and commit values.
See this PR for an example: https://github.com/flathub/eu.usdx.UltraStarDeluxe/pull/7/files
16 changes: 16 additions & 0 deletions UPDATING-DLLS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Updating DLLs
The Windows DLLs are stored as releases in the [mxe](https://github.com/UltraStar-Deluxe/mxe) repository.

If you need to update them:
1. Open a PR in the [mxe](https://github.com/UltraStar-Deluxe/mxe) repository
2. Open a PR in the USDX repository that updates the commit id in [dldlls.py](dldlls.py)
3. Once everything works, merge the PR in the mxe repository
4. Update the PR in the USDX repository to point to the commit id of the merge commit from step 3
5. Merge the PR in the USDX repository and make a pre-release in the mxe repository. Pre-releases have `-rc1` added to the name of both the release and the zip asset!

## Release updated DLLs
When releasing a new version of USDX that uses new DLLs for the first time, edit the pre-release:
* change the name (name it the same the USDX version you're about to release)
* rename the zip asset
* unmark it as pre-release
* set as latest release