Add Release Checklist #144
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smk4664
reviewed
Aug 13, 2024
glennmatthews
previously approved these changes
Aug 13, 2024
gsnider2195
reviewed
Aug 13, 2024
nautobot-app-chatops/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 13, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 13, 2024
nautobot-app/{{ cookiecutter.project_slug }}/development/towncrier_template.j2
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 21, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Outdated
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 21, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Outdated
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
Comment on lines
+164
to
+171
| First, sync your `main` branch with upstream changes: `git switch main && git pull`. | ||
|
|
||
| Create a new branch from `main` called `release-1.4.2-to-develop` and use `poetry version prepatch` to bump the development version to the next release. | ||
|
|
||
| For example, if you just released `v1.4.2`: | ||
|
|
||
| ```no-highlight | ||
| > git switch -c release-1.4.2-to-develop main |
There was a problem hiding this comment.
For future versions of this you can skip the git switch main && git pull and just create your branch off of the upstream branch:
git fetch
git switch -c release-1.4.2-to-develop origin/main
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Outdated
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Outdated
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
reviewed
Aug 22, 2024
| 6. Add all the changes and `git commit -m "Release v1.2.3"`, then `git push`. | ||
| 7. Open a new PR against `ltm-1.6`. Once CI is passing in the PR, `Create a merge commit` (don't squash!). | ||
| 8. Create a New Release in GitHub - use the same steps documented [here](#create-a-new-release-in-github). | ||
| 9. Open a separate PR against `develop` to synchronize all LTM release changelogs into the latest version of the docs for visibility. |
There was a problem hiding this comment.
Might be a good idea to emphasize that we're only updating docs in develop
…checklist.md Co-authored-by: Gary Snider <[email protected]>
…checklist.md Co-authored-by: Gary Snider <[email protected]>
…checklist.md Co-authored-by: Gary Snider <[email protected]>
…checklist.md Co-authored-by: Gary Snider <[email protected]>
gsnider2195
previously approved these changes
Aug 22, 2024
|
Just because I hit this today, the |
cmsirbu
commented
Sep 17, 2024
nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/release_checklist.md
Show resolved
Hide resolved
gsnider2195
previously approved these changes
Oct 7, 2024
gsnider2195
reviewed
Oct 7, 2024
|
|
||
| ### Create a New Release in GitHub | ||
|
|
||
| Draft a [new release](https://github.com/nautobot/nautobot-app-dev-example/releases/new) with the following parameters. |
There was a problem hiding this comment.
Do we want these 3 instances of nautobot-app-dev-example to be changed to {{ cookiecutter.project_slug }}?
gsnider2195
reviewed
Oct 7, 2024
|
|
||
| ```no-highlight | ||
| > poetry version | ||
| nautobot-dev-example 1.0.0-beta.2 |
There was a problem hiding this comment.
Does this need to be {{ cookiecutter.app_slug }}?
gsnider2195
approved these changes
Oct 10, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents, step by step, what a maintainer should do when cutting a new release for an open source App.
major.minorinvoke generate-release-notes#115I have tested these changes successfully in the https://github.com/nautobot/nautobot-app-dev-example repo, with the exception of the LTM steps, due to a lack of an LTM branch in dev-example.