further clarify release process

nautobot · Mar 9, 2024 · ec71b09 · ec71b09
1 parent 3eedecf
commit ec71b09
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md
@@ -53,19 +53,24 @@ The branching policy includes the following tenets:
 
 {{ cookiecutter.verbose_name }} has currently no intended scheduled release schedule, and will release new features in minor versions.
 
-When a new release, from `develop` to `main`, is created the following should happen.
+When a release is ready to be created from either `develop` or `ltm-x.x`, the following should happen.
 
-- A release PR is created from `develop` with:
+- Create a release PR by:
+    - Source from develop or `ltm-<major>.<minor>` and creatch new branch, generally `release/<major>.<minor>.<patch>`.
     - Update the release notes in `docs/admin/release_notes/version_<major>.<minor>.md` file to reflect the changes.
+        - You can run `invoke generate-release-notes` to generate these notes and delete the legacy towncrier fragments.
+        - Please consider adding changelog's from ltm releases in current release, as applicable.
     - Update the mkdocs.yml file to include the reference to `docs/admin/release_notes/version_<major>.<minor>.md` as applicable.
     - Change the version from `<major>.<minor>.<patch>-beta` to `<major>.<minor>.<patch>` in `pyproject.toml`.
-    - Set the PR to the `main` branch.
+    - Set the PR to the `main` or `ltm-<major>.<minor>` branch respectivly.
 - Ensure the tests for the PR pass.
 - Merge the PR.
 - Create a new tag:
     - The tag should be in the form of `v<major>.<minor>.<patch>`.
     - The title should be in the form of `v<major>.<minor>.<patch>`.
     - The description should be the changes that were added to the `version_<major>.<minor>.md` document.
+    - Include full changelog in description `**Full Changelog**: https://github.com/nautobot/<repo-name>/compare/v<prior-verion>...v<current-verion>`.
+    - **Note** Please ensure to uncheck `Set as the latest release` when updating an ltm release.
 - If merged into `main`, then push from `main` to `develop`, in order to retain the merge commit created when the PR was merged
 - A post release PR is created with:
     - Change the version from `<major>.<minor>.<patch>` to `<major>.<minor>.<patch + 1>-beta` in `pyproject.toml`.