Skip to content

Commit

Permalink
Merge pull request #735 from nautobot/main
Browse files Browse the repository at this point in the history
Main back into develop
  • Loading branch information
itdependsnetworks authored Mar 11, 2024
2 parents cc87d64 + 8daf92f commit dc713b1
Show file tree
Hide file tree
Showing 9 changed files with 45 additions and 22 deletions.
1 change: 0 additions & 1 deletion changes/692.added

This file was deleted.

1 change: 0 additions & 1 deletion changes/692.changed

This file was deleted.

2 changes: 0 additions & 2 deletions changes/692.fixed

This file was deleted.

1 change: 0 additions & 1 deletion changes/707.changed

This file was deleted.

1 change: 0 additions & 1 deletion changes/731.fixed

This file was deleted.

1 change: 0 additions & 1 deletion changes/8.housekeeping

This file was deleted.

28 changes: 26 additions & 2 deletions docs/admin/release_notes/version_2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,30 @@
!!! note
Please see [migrating guide](../migrating_to_v2.md) for details on migration.

## v2.0.2 - 2024-03

### Added

- [#707](https://github.com/nautobot/nautobot-app-golden-config/pull/707) - Added autoformat invoke command.
- [#730](https://github.com/nautobot/nautobot-app-golden-config/pull/730) - Added app config schema generator and validator.

### Fixed

- [#699](https://github.com/nautobot/nautobot-app-golden-config/pull/699) - Fixed stale reference to platform_slug_map.
- [#719](https://github.com/nautobot/nautobot-app-golden-config/pull/719) - Fixed generate config plans Status filter.
- [#715](https://github.com/nautobot/nautobot-app-golden-config/pull/715) - Fixed close threaded db connections during config deployment.
- [#726](https://github.com/nautobot/nautobot-app-golden-config/pull/726) - Fixed objectchange log excludes for object_data_v2 data as well.
- [#718](https://github.com/nautobot/nautobot-app-golden-config/pull/718) - Fixed logic to handle jobs requiring approvals.
- [#724](https://github.com/nautobot/nautobot-app-golden-config/pull/724) - Fixed performance issue on UNIX file diff view.
- [#724](https://github.com/nautobot/nautobot-app-golden-config/pull/724) - Fixed non-working repos list creation and syncing.
- [#731](https://github.com/nautobot/nautobot-app-golden-config/pull/731) - Fixed missing right panel with config types.
- [#734](https://github.com/nautobot/nautobot-app-golden-config/pull/734) - Fixed incorrect netutils_parser lookup.

### Changed

- [#691](https://github.com/nautobot/nautobot-app-golden-config/pull/691) - Changed repo name and references to nautobot-app-golden-config.
- [#707](https://github.com/nautobot/nautobot-app-golden-config/pull/707) - Changed from pydocstyle to ruff.
- [#707](https://github.com/nautobot/nautobot-app-golden-config/pull/707) - Changed release notes to towncrier based.

## v2.0.1 - 2023-12

Expand All @@ -25,8 +49,8 @@

### Changed

- [#658](https://github.com/nautobot/nautobot-app-golden-config/pull/658) - Cookie updated by NetworkToCode Cookie Drift Manager Tool
- [#671](https://github.com/nautobot/nautobot-app-golden-config/pull/671) - Finish Documentation Updates from Drift Manager
- [#658](https://github.com/nautobot/nautobot-app-golden-config/pull/658) - Cookie updated by NetworkToCode Cookie Drift Manager Tool.
- [#671](https://github.com/nautobot/nautobot-app-golden-config/pull/671) - Finish Documentation Updates from Drift Manager.

## v2.0.0 - 2023-09

Expand Down
30 changes: 18 additions & 12 deletions docs/dev/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,26 @@ Golden Config will observe semantic versioning, as of 1.0. This may result in a

Golden Config 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.

- 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.
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-<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`.
- 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.
- 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__`.
- 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 `pyproject.toml`.
- Set the PR to the proper branch, `develop`.
- Once tests pass, merge.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "nautobot-golden-config"
version = "2.0.0"
version = "2.0.2"
description = "An app for configuration on nautobot"
authors = ["Network to Code, LLC <[email protected]>"]
license = "Apache-2.0"
Expand Down

0 comments on commit dc713b1

Please sign in to comment.