Rooba
/
wagtail
mirror of https://github.com/wagtail/wagtail.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Creating a new Wagtail release (markdown)

sag᠎e 2023-06-06 18:08:23 +01:00
parent 616595cb2c
commit 355b73bc0e
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Creating-a-new-Wagtail-release.md

@ -17,7 +17,9 @@
* Update `wagtail/project_template/requirements.txt` with the new version number * Update `wagtail/project_template/requirements.txt` with the new version number
* For a release candidate, use the exact version: `wagtail==2.8rc1` * For a release candidate, use the exact version: `wagtail==2.8rc1`
* For a major, minor or patch release, use a range covering the minor release (e.g. `wagtail>=2.8,<2.9`) * For a major, minor or patch release, use a range covering the minor release (e.g. `wagtail>=2.8,<2.9`)
* **For a major, minor or patch release:** fill in the release date, and remove any `IN DEVELOPMENT` text, in `CHANGELOG.txt` and the release notes page in `docs/` * **For a major, minor or patch release:** fill in the release date, and remove any `IN DEVELOPMENT` text, in:
* `CHANGELOG.txt`
* the release notes page in `docs/`
* Confirm that the latest revision is passing on [GitHub Actions CI](https://github.com/wagtail/wagtail/actions) * Confirm that the latest revision is passing on [GitHub Actions CI](https://github.com/wagtail/wagtail/actions)
You can do the above steps with your existing clone of the Wagtail repository. You can do the above steps with your existing clone of the Wagtail repository.
@ -96,6 +98,21 @@ Readthedocs will spot the addition of a release tag with a newer version number,
* Update docs in [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Wagtail) for offline docs apps [Dash](https://kapeli.com/dash) and [Zeal](https://zealdocs.org/). * Update docs in [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Wagtail) for offline docs apps [Dash](https://kapeli.com/dash) and [Zeal](https://zealdocs.org/).
* Follow the instructions on the README.md and submit a pull request with updated docs. * Follow the instructions on the README.md and submit a pull request with updated docs.
If you made a mistake in the documentation before the git tag was created and would like to update the documentation for the release, you can do the following steps:
<details>
<summary>Steps</summary>
- Delete the tag via https://github.com/wagtail/wagtail/tags
- If a GitHub release has been created, you need to delete it before deleting the tag
- Delete the tag locally with `git tag -D v5.0.1`
- Create a new tag with `git tag v5.0.1`
- Push the new tag with `git push upstream --tags`
- Trigger a new rebuild of the documentation for the release's branch on readthedocs
</details>
## releases.wagtail.org ## releases.wagtail.org
Once the new release is out, please update https://releases.wagtail.org/latest.txt accordingly. You'll need AWS credentials for the S3 bucket and Cloudfront cache, which are held by the Torchbox sysadmins. Once the new release is out, please update https://releases.wagtail.org/latest.txt accordingly. You'll need AWS credentials for the S3 bucket and Cloudfront cache, which are held by the Torchbox sysadmins.