Skip to content

Commit

Permalink
Merge pull request #100 from nautobot/releases/nautobot-app-v2.2.1
Browse files Browse the repository at this point in the history
Release nautobot-app-v2.2.1
  • Loading branch information
snaselj committed Mar 15, 2024
2 parents cb606c9 c6958d1 commit 66024e1
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 13 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/tag-nautobot-app-v2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 15,7 @@ jobs:
max-parallel: 5 # Limit of concurrent jobs
matrix:
name:
- "bgp-models"
- "capacity-metrics"
- "chatops"
- "circuit-maintenance"
Expand All @@ -29,7 30,7 @@ jobs:
# - "nornir" # Postponed
- "secrets-providers"
- "ssot"
# - "version-control" # Disabled as not Nautobot 2.0 ready
- "version-control"
- "welcome-wizard"
steps:
- name: "Re-bake"
Expand Down
19 changes: 19 additions & 0 deletions docs/admin/release_notes/version_2.2.md
Original file line number Diff line number Diff line change
@@ -1,5 1,7 @@
# v2.2 Release Notes

This document describes all new features and changes in the release `2.2`. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v2.2.0] - 2024-03-06

**Full Changelog**: https://github.com/nautobot/cookiecutter-nautobot-app/compare/nautobot-app-v2.1.0...nautobot-app-v2.2.0
Expand All @@ -26,3 28,20 @@
### Removed

- Removed `nautobot-app-nornir` from managed apps. #84

## [v2.2.1] - 2024-03-15

**Full Changelog**: https://github.com/nautobot/cookiecutter-nautobot-app/compare/nautobot-app-v2.2.0...nautobot-app-v2.2.1

### Added

- Manage BGP Models.
- Manage Version Control.

### Changed

- Updated the release policy documentation.

### Fixed

- Fixed leaking of cookiecutter template snippet to the Towncrier template.
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
{% raw %}
{% if render_title %}
## [v{{ versiondata.version }} ({{ versiondata.date }})]({{ cookiecutter.repo_url }}/releases/tag/v{{ versiondata.version}})
## [v{{ versiondata.version }} ({{ versiondata.date }})]({% endraw %}{{ cookiecutter.repo_url }}{% raw %}/releases/tag/v{{ versiondata.version}})

{% endif %}
{% for section, _ in sections.items() %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 47,7 @@ The branching policy includes the following tenets:
- PRs intended to add new features should be sourced from the `develop` branch.
- PRs intended to fix issues in the Nautobot LTM compatible release should be sourced from the latest `ltm-<major.minor>` branch instead of `develop`.

{{ cookiecutter.verbose_name }} will observe semantic versioning, as of 1.0. This may result in a quick turnaround in minor versions to keep pace with an ever growing feature set.
{{ cookiecutter.verbose_name }} will observe semantic versioning, as of 1.0. This may result in a quick turnaround in minor versions to keep pace with an ever-growing feature set.

## Release Policy

Expand All @@ -56,17 56,17 @@ The branching policy includes the following tenets:
When a new release, from `develop` to `main`, is created the following should happen.

- A release PR is created from `develop` with:
- Update the release notes in `docs/admin/release_notes/version_<major>.<minor>.md` file to reflect the changes.
- Change the version from `<major>.<minor>.<patch>-beta` to `<major>.<minor>.<patch>` in `pyproject.toml`.
- Set the PR to the `main` branch.
- Update the release notes in `docs/admin/release_notes/version_<major>.<minor>.md` file to reflect the changes.
- Change the version from `<major>.<minor>.<patch>-beta` to `<major>.<minor>.<patch>` in `pyproject.toml`.
- Set the PR to the `main` branch.
- 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.
- 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.
- 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__`.
- Set the PR to the proper branch, `develop`.
- Once tests pass, merge.
- Change the version from `<major>.<minor>.<patch>` to `<major>.<minor>.<patch 1>-beta` in both `pyproject.toml` and `nautobot.__init__.__version__`.
- Set the PR to the proper branch, `develop`.
- Once tests pass, merge.
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 22,5 @@
</tr>
</table>
</div>
{% endblock %}
{% endblock content_left_page %}
{% endraw %}

0 comments on commit 66024e1

Please sign in to comment.