solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Update the instructions for creating releases on GitHub

Browse source 
Explain how to use the new workflow to automate even more parts of the
release process.
This commit is contained in:
Vadim Zeitlin 2022-09-15 18:45:06 +02:00
parent 391555d341
commit dd50c77a88
1 changed files with 21 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

85
docs/contributing/how-to-release.md
View file

@ -1,21 +1,5 @@
# Making a New wxWidgets Release
Creating a new release requires a few things before getting started:
* Linux (or another Unix but GNU tar is required).
* Windows 7+ with HTML Help Workshop, and Inno Setup installed.
* 7-Zip, Doxygen 1.8.8, and GraphViz installed on both machines.
* [Bakefile 0.2.12](https://bakefile.org/) installed on the linux machine.
Unless mentioned otherwise, all steps should be run on Linux or OSX so that the
repository export used for the release is primarily using LF line endings. Files
that require CRLF line endings will be converted appropriately.
*Important:* Ensure that 7-Zip, HTML Help Workshop, Doxygen, GraphViz and Inno
Setup have all been added to your Path in Windows. You can confirm this by
running `7z`, `hhc`, `iscc`, `doxygen -v`, and `dot -V` in a command prompt.
Add the missing installed folder locations of any executables to your Path.
## Checking ABI Compatibility
For the stable (even) releases only, check that binary compatibility hasn't
@ -92,71 +76,41 @@ Commit the changes and tag the release using your GPG key:
Don't overwrite existing tags. For non-final releases use e.g. `X.Y.Z-rc1`
instead of `X.Y.Z`.
## Creating Release Files
## Creating Release On GitHub
The release scripts can be run from any working directory, and they will
generate all release package files under `distrib/release/x.y.z`. The scripts
mostly build the release packages based on the current HEAD commit, so always
ensure you have the appropriate tag or commit checked out.
Go to https://github.com/wxWidgets/wxWidgets/actions/workflows/make_release.yml
and use the "Run workflow" button to manually run this workflow for the
appropriate branch (either `master` or `3.2` currently). This will create a new
draft release that can be found in the release list or you can see its exact
URL in the output of the "Add Files to the Release" workflow step.
1. Run `./build/tools/release.sh x.y.z` to create source archives
`wxWidgets-x.y.z.{7z,tar.bz2,zip}`, `wxWidgets-x.y.z-headers.7z`, and
`wxWidgets-x.y.z-docs-html.{tar.bz2,zip}` packages.
On the release page, use the "Edit" button to manually move the checksums at
the very end of the announcement text to their correct locations (i.e. replace
the all zero checksums with the actual ones).
2. Copy just the `wxWidgets-x.y.z.zip` package into the same
`distrib\release\x.y.z` folder on Windows.
Also review the announcement for correctness.
3. Run `build/tools/release.bat x.y.z` in a Windows command prompt. To avoid
confusion note that, unlike other generated files, the Windows installer is
created based on files as well as instructions (`build/tools/wxwidgets.iss`)
contained in the copied release ZIP and not from the current working wx
directory.
Build and upload the binaries to the existing release.
4. Copy `wxMSW-x.y.z-Setup.exe` back to your Linux or OSX `distrib/release/x.y.z`
directory so you can continue with the upload step with all packages
available. Also create a ZIP file from the CHM one:
zip wxWidgets-x.y.z-docs-chm.zip wxWidgets-x.y.z.chm
and copy/move it to the same directory.
5. Run `./build/tools/post-release.sh` to update the SHA-1 sums in
`docs/release.md`, then commit the changes. Notice that when making an RC,
the version must be explicitly specified on this script command line.
## Uploading
Create a new release on GitHub using vX.Y.Z tag and title.
Use the content of `docs/release.md` for the release description box.
Attach the following files to it:
wxMSW-Setup-x.y.z.exe
wxWidgets-x.y.z.7z
wxWidgets-x.y.z.tar.bz2
wxWidgets-x.y.z.zip
wxWidgets-x.y.z-docs-chm.zip
wxWidgets-x.y.z-docs-html.tar.bz2
wxWidgets-x.y.z-docs-html.zip
wxWidgets-x.y.z-headers.7z
Finally, publish it.
## Update documentation
This requires being able to ssh to docs.wxwidgets.org, please ask Bryan if you
think you should be able to do it, but can't.
Once logged in, run `~/update-trunk-docs.sh` script to update files in
`public_html/trunk` directory, copy its contents to `public_html/x.y.z`, switch
any links, such as `3.1` to point to `x.y.z` by doing
Once logged in, copy the contents of either `latest` or `stable` directory to
`public_html/x.y.z`, switch any links, such as `3.1` to point to `x.y.z` by
doing
$ cd ~/public_html
$ ln -sfn 3.y.z 3.y
and edit `~/public_html/index.html` to add the link to the new release to it.
If the docs must be generated from the tag itself, and not from master, check
out the tag first and return to master branch after doing it.
If the docs must be generated from the tag itself, run the documentation
generation workflow on GitHub manually providing the tag before doing the
above.
Note that the docs web site currently uses Cloudflare for caching, which means
that it won't update for several hours after the change, unless you purge the
@ -189,6 +143,9 @@ For major releases, submit the announcement to https://slashdot.org/submission
## Post-Release Steps
* Update the SHA-1 sums in `docs/release.md` using the checksums from the release
announcement, then commit the changes.
* Mark the milestone corresponding to the release as completed at
https://github.com/wxWidgets/wxWidgets/milestones