Merge pull request #752 from nautobot/prep-v2.0.4

prep for 2.0.4 release

.cookiecutter.json

@@ -21,15 +21,15 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.2.0",
+            "template_ref": "refs/tags/nautobot-app-v2.2.1",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
             "post_actions": [
                 "black"
             ],
             "draft": true,
-            "baked_commit_ref": "1f3e36613d3c301a807cdbdc4a90e849fd88c554"
+            "baked_commit_ref": "78686cacfb51540281444ff112705b91304f797c"
         }
     }
 }

docs/admin/release_notes/version_2.0.md

@@ -12,6 +12,15 @@
     Please see [migrating guide](../migrating_to_v2.md) for details on migration.
 
 
+## v2.0.4 2024-04
+
+### Fixed
+
+- [#749](https://github.com/nautobot/nautobot-app-golden-config/issues/749) - Corrected issue where consecutive Golden Config Jobs in All Golden Configs Job wouldn't execute if prior Job had an Exception raised.
+
+### Housekeeping
+
+- [#741](https://github.com/nautobot/nautobot-app-golden-config/issues/741) - Re-baked from the latest template.
 ## v2.0.3 2024-03
 
 ### Added

docs/admin/troubleshooting/E3027.md

@@ -0,0 +1,17 @@
+# E3027 Details
+
+## Message emitted:
+
+`E3027: NornirNautobotException raised during backup tasks. Original exception message`
+
+## Description:
+
+A NornirNautobotException is raised during a Backup Job.
+
+## Troubleshooting:
+
+Review the exception message and worker logs to determine the cause of the failure.
+
+## Recommendation:
+
+This type of error is usually resource related or caused by a misconfiguration and should be logged as such.

docs/admin/troubleshooting/E3028.md

@@ -0,0 +1,17 @@
+# E3028 Details
+
+## Message emitted:
+
+`E3028: NornirNautobotException raised during compliance tasks. Original exception message`
+
+## Description:
+
+A NornirNautobotException is raised during a Compliance Job.
+
+## Troubleshooting:
+
+Review the exception message and worker logs to determine the cause of the failure.
+
+## Recommendation:
+
+This type of error is usually resource related or caused by a misconfiguration and should be logged as such.

docs/admin/troubleshooting/E3029.md

@@ -0,0 +1,17 @@
+# E3029 Details
+
+## Message emitted:
+
+`E3029: NornirNautobotException raised during intended tasks. Original exception message`
+
+## Description:
+
+A NornirNautobotException is raised during an Intended Job.
+
+## Troubleshooting:
+
+Review the exception message and worker logs to determine the cause of the failure.
+
+## Recommendation:
+
+This type of error is usually resource related or caused by a misconfiguration and should be logged as such.

docs/admin/troubleshooting/E3030.md

@@ -0,0 +1,17 @@
+# E3030 Details
+
+## Message emitted:
+
+`E3030: Failure during (Backup, Intended, Compliance) Job(s).`
+
+## Description:
+
+A NornirNautobotException is raised during a Backup, Intended, or Compliance Job.
+
+## Troubleshooting:
+
+Review the exception message and worker logs to determine the cause of the failure.
+
+## Recommendation:
+
+This type of error is usually resource related or caused by a misconfiguration and should be logged as such.

docs/dev/contributing.md

@@ -47,32 +47,26 @@ 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`.
 
-Golden Config 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.
+Golden Config 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
 
 Golden Config has currently no intended scheduled release schedule, and will release new features in minor versions.
 
 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>`.
+- 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.
-        - 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.
+    - 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.
-    - 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 `pyproject.toml`.
+    - 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.
+    - Once tests pass, merge.

nautobot_golden_config/exceptions.py

@@ -11,3 +11,15 @@ class MissingReference(GoldenConfigError):
 
 class RenderConfigToPushError(GoldenConfigError):
     """Exception related to Render Configuration Postprocessing operations."""
+
+
+class BackupFailure(GoldenConfigError):
+    """Custom error for when there's a failure in Backup Job."""
+
+
+class IntendedGenerationFailure(GoldenConfigError):
+    """Custom error for when there's a failure in Intended Job."""
+
+
+class ComplianceFailure(GoldenConfigError):
+    """Custom error for when there's a failure in Compliance Job."""