ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 08:17:13 +03:00
Code Issues Projects Releases Wiki Activity

docs: RELEASING.md: Mostly have the actual release procedure documented now.

Browse Source 
There's a 'TODO' for generating the zip and tar.gz source files.
This commit is contained in:
Athanasius 2020-06-15 17:42:04 +01:00
parent ade048d1fc
commit 381c039a31
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/RELEASING.md
View File

@ -116,8 +116,25 @@ Finally, uninstall your current version of ED Market Connector and re-install us
Distribution
---
Put the `EDMarketConnector_win_<version>.msi` file in place where you're releasing the files.
It is recommended to keep all the files for distribution on github, including the 'update_feed' file. So once you have tested the new .msi file
For the `edmarketconnector.xml` update you'll need to edit the existing file:
1. Update the `<title>` and `<description>` texts to reflect the latest version and the additional changelog.
1. Update the `url`, `sparkle:version` and `length` elements as per the latest appcast_win_<version>.xml file geneated by the build process. Ensure the `url` does match where you uploaded the `.msi` file.
1. You should have already decided on the new version number, as it's specified in `config.py`. You'll need to redo the `.msi` build if you forgot. **Remember to do a fresh git commit for this change.**
1. Keep in mind that despite being specified as, e.g. '3.5.0.0' the `setup.py` code only takes note of the first 3 parts for deciding the release number. i.e. `3.5.0.1` results in the same `rel-350/EDMarketConnector_win_350.msi` as '3.5.0.0' does.
1. Prepare a changelog text for the release. You'll need this both for the github release and the contents of the `edmarketconnector.xml` file.
1. Update `edmarketconnector.xml` to add this changelog text to the correct section.
1. You'll need to change the `<title>` and `<description>` texts to reflect the latest version and the additional changelog.
1. Update the `url`, `sparkle:version` and `length` elements of the `<enclosure>` section as per the latest appcast_win_<version>.xml file generated by the build process.
1. **DO NOT git commit this change or push to github**. *We need to get the github release in place first before changing the file that running EDMC clients will check.*
1. Add a git tag for the release, which you'll refer to when actually creating the release:
1. Add a git tag matching the `rel-XYZ` part of the URL in the `appcast_win_XYX.msi` file. e.g. `git tag -a rel-350`
1. Ensure this tag is pushed to github: `git push --tags <github remote>`
1. TODO: Generate the Source Code zip and tar.gz files.
1. Craft a new github Release, using the tag you added before. Include the .msi file for Windows and the Source Code files if you have them. Use the changelog text you already prepared.
1. Check that the URL for the release that you specified in `edmarketconnector.xml` actually matches where github has placed the `.msi` file.
1. **NOW commit the latest `edmarketconnector.xml` changes and push to github.** This is the step that fully publishes the release for running EDMC instances to pick up on 'Check for Updates'. Yes, this means that this step isn't included in the git tag, but the alternative (with hosting the file via github raw URL) is to have a race condition where a running EDMC instance might check the file and see there's a new version *before that new version is actually available for download*.