Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contributing docs to include updates to mkdocs.yml file #99

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Update contributing docs to include updates to mkdocs.yml file #99

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3eedecf
Update contributing docs to include updates to mkdocs.yml file
itdependsnetworks Mar 9, 2024
ec71b09
further clarify release process
itdependsnetworks Mar 9, 2024
6e0551d
missing code block
itdependsnetworks Mar 9, 2024
2d62b30
remove back tick
itdependsnetworks Mar 9, 2024
e4940e3
spelling fix
itdependsnetworks Mar 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions nautobot-app/{{ cookiecutter.project_slug }}/docs/dev/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,26 @@ 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>` branch 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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Best way to do this is poetry version <major>.<minor>.<patch> rather than manually editing pyproject.toml. Same comment on line 70/76 below.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(or to just bump it to the next release version, poetry version patch or poetry version minor as appropriate).

- Set the PR to the `main` branch.
- Set the PR to the `main` or `ltm-<major>.<minor>` branch respectively.
- 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 both `pyproject.toml` and `nautobot.__init__.__version__`.
- Change the version from `<major>.<minor>.<patch>` to `<major>.<minor>.<patch + 1>-beta` in `pyproject.toml`.
- Set the PR to the proper branch, `develop`.
- Once tests pass, merge.
Loading