NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 01:41:22 -06:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Update release checklist for v4.1

Browse Source
This commit is contained in:
Jeremy Stretch 2024-08-15 12:59:44 -04:00
parent 33e8e04281
commit 8e70e3ad20
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/development/release-checklist.md
View File

@ -2,9 +2,9 @@
This documentation describes the process of packaging and publishing a new NetBox release. There are three types of release: This documentation describes the process of packaging and publishing a new NetBox release. There are three types of release:
* Major release (e.g. v2.11 to v3.0) * Major release (e.g. v3.7.8 to v4.0.0)
* Minor release (e.g. v3.2 to v3.3) * Minor release (e.g. v4.0.10 to v4.1.0)
* Patch release (e.g. v3.3.0 to v3.3.1) * Patch release (e.g. v4.1.0 to v4.1.1)
While major releases generally introduce some very substantial change to the application, they are typically treated the same as minor version increments for the purpose of release packaging. While major releases generally introduce some very substantial change to the application, they are typically treated the same as minor version increments for the purpose of release packaging.
@ -90,7 +90,7 @@ Updated language translations should be pulled from [Transifex](https://app.tran
### Update Version and Changelog ### Update Version and Changelog
* Update the `VERSION` constant in `settings.py` to the new release version. * Update the version and published date in `release.yaml` with the current version & date. Add a designation (e.g.g `beta1`) if applicable.
* Update the example version numbers in the feature request and bug report templates under `.github/ISSUE_TEMPLATES/`. * Update the example version numbers in the feature request and bug report templates under `.github/ISSUE_TEMPLATES/`.
* Replace the "FUTURE" placeholder in the release notes with the current date. * Replace the "FUTURE" placeholder in the release notes with the current date.
@ -117,16 +117,6 @@ Create a [new release](https://github.com/netbox-community/netbox/releases/new)
Once created, the release will become available for users to install. Once created, the release will become available for users to install.
### Update the Development Version
On the `develop` branch, update `VERSION` in `settings.py` to point to the next release. For example, if you just released v3.3.1, set:
```
VERSION = 'v3.3.2-dev'
```
Commit this change with the comment "PRVB" (for _post-release version bump_) and push the commit upstream.
### Update the Public Documentation ### Update the Public Documentation
After a release has been published, the public NetBox documentation needs to be updated. This is accomplished by running two actions on the [netboxlabs-docs](https://github.com/netboxlabs/netboxlabs-docs) repository. After a release has been published, the public NetBox documentation needs to be updated. This is accomplished by running two actions on the [netboxlabs-docs](https://github.com/netboxlabs/netboxlabs-docs) repository.