From 3eedecf2f112e560490c52aeab2b7d680f397f6f Mon Sep 17 00:00:00 2001 From: Ken Celenza Date: Sat, 9 Mar 2024 08:09:38 -0500 Subject: [PATCH 1/5] Update contributing docs to include updates to mkdocs.yml file --- .../{{ cookiecutter.project_slug }}/docs/dev/contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md index 045decd4..00f9cec8 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md +++ b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md @@ -57,6 +57,7 @@ When a new release, from `develop` to `main`, is created the following should ha - A release PR is created from `develop` with: - Update the release notes in `docs/admin/release_notes/version_..md` file to reflect the changes. + - Update the mkdocs.yml file to include the reference to `docs/admin/release_notes/version_..md` as applicable. - Change the version from `..-beta` to `..` in `pyproject.toml`. - Set the PR to the `main` branch. - Ensure the tests for the PR pass. @@ -67,6 +68,6 @@ When a new release, from `develop` to `main`, is created the following should ha - The description should be the changes that were added to the `version_..md` document. - 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 `..` to `..-beta` in both `pyproject.toml` and `nautobot.__init__.__version__`. + - Change the version from `..` to `..-beta` in `pyproject.toml`. - Set the PR to the proper branch, `develop`. - Once tests pass, merge. From ec71b0937fd5f798225d54cda94cfc58c866496b Mon Sep 17 00:00:00 2001 From: Ken Celenza Date: Sat, 9 Mar 2024 09:27:15 -0500 Subject: [PATCH 2/5] further clarify release process --- .../docs/dev/contributing.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md index 00f9cec8..e888bc7e 100644 --- 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-.` and creatch new branch, generally `release/..`. - Update the release notes in `docs/admin/release_notes/version_..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_..md` as applicable. - Change the version from `..-beta` to `..` in `pyproject.toml`. - - Set the PR to the `main` branch. + - Set the PR to the `main` or `ltm-.` 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..`. - The title should be in the form of `v..`. - The description should be the changes that were added to the `version_..md` document. + - Include full changelog in description `**Full Changelog**: https://github.com/nautobot//compare/v...v`. + - **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 `..` to `..-beta` in `pyproject.toml`. From 6e0551ddf8211bdbf4d87dfed9c2ab25abd9362b Mon Sep 17 00:00:00 2001 From: Ken Celenza Date: Sat, 9 Mar 2024 09:29:56 -0500 Subject: [PATCH 3/5] missing code block --- .../{{ cookiecutter.project_slug }}/docs/dev/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md index e888bc7e..dfdc2767 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md +++ b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md @@ -56,7 +56,7 @@ The branching policy includes the following tenets: When a release is ready to be created from either `develop` or `ltm-x.x`, the following should happen. - Create a release PR by: - - Source from develop or `ltm-.` and creatch new branch, generally `release/..`. + - Source from `develop`` or `ltm-.` branch and creatch new branch, generally `release/..`. - Update the release notes in `docs/admin/release_notes/version_..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. From 2d62b308bdab7d659d1c7954760d2c07c114556d Mon Sep 17 00:00:00 2001 From: Ken Celenza Date: Sat, 9 Mar 2024 09:30:13 -0500 Subject: [PATCH 4/5] remove back tick --- .../{{ cookiecutter.project_slug }}/docs/dev/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md index dfdc2767..83e68e53 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md +++ b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md @@ -56,7 +56,7 @@ The branching policy includes the following tenets: When a release is ready to be created from either `develop` or `ltm-x.x`, the following should happen. - Create a release PR by: - - Source from `develop`` or `ltm-.` branch and creatch new branch, generally `release/..`. + - Source from `develop` or `ltm-.` branch and creatch new branch, generally `release/..`. - Update the release notes in `docs/admin/release_notes/version_..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. From e4940e3d75964d08b3760e1ed3eef4db79771035 Mon Sep 17 00:00:00 2001 From: Ken Celenza Date: Sat, 9 Mar 2024 13:18:12 -0500 Subject: [PATCH 5/5] spelling fix --- .../{{ cookiecutter.project_slug }}/docs/dev/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md index 83e68e53..81a86f3c 100644 --- a/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md +++ b/nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md @@ -62,7 +62,7 @@ When a release is ready to be created from either `develop` or `ltm-x.x`, the fo - 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_..md` as applicable. - Change the version from `..-beta` to `..` in `pyproject.toml`. - - Set the PR to the `main` or `ltm-.` branch respectivly. + - Set the PR to the `main` or `ltm-.` branch respectively. - Ensure the tests for the PR pass. - Merge the PR. - Create a new tag: