Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool

Template:

```
{
    "template": "https://github.com/networktocode-llc/cookiecutter-ntc.git",
    "dir": "python",
    "ref": "main",
    "path": "/__w/cookiecutter-nautobot-app-drift-manager/cookiecutter-nautobot-app-drift-manager/cookiecutter-ntc/python"
}
```

Cookie:

```
{
    "remote": "https://github.com/networktocode/pyntc.git",
    "path": "/tmp/tmpjh04xc0r/pyntc",
    "repository_path": "/tmp/tmpjh04xc0r/pyntc",
    "dir": "",
    "branch_prefix": "drift-manager/develop",
    "context": {
        "codeowner_github_usernames": "@jeffkala @pszulczewski @pke11y",
        "full_name": "Network to Code, LLC",
        "email": "info@networktocode.com",
        "github_org": "networktocode",
        "description": "Python library focused on tasks related to device level and OS management.",
        "project_name": "pyntc",
        "project_slug": "pyntc",
        "repo_url": "https://github.com/networktocode/pyntc",
        "base_url": "pyntc",
        "project_python_name": "pyntc",
        "project_python_base_version": "3.10",
        "project_with_config_settings": "no",
        "generate_docs": "no",
        "version": "2.0.2",
        "original_publish_year": "2015",
        "_template": "/__w/cookiecutter-nautobot-app-drift-manager/cookiecutter-nautobot-app-drift-manager/cookiecutter-ntc/python",
        "_output_dir": "/tmp/tmpjh04xc0r",
        "_repo_dir": "/__w/cookiecutter-nautobot-app-drift-manager/cookiecutter-nautobot-app-drift-manager/cookiecutter-ntc/python",
        "_checkout": null
    },
    "drift_managed_branch": "develop",
    "remote_name": "origin",
    "pull_request_strategy": "PullRequestStrategy.UPDATE_OR_CREATE",
    "post_actions": [],
    "baked_commit_ref": "a5add2662f26a3b877635bbf1fd787682414d2bf",
    "draft": false
}
```

CLI Arguments:

```
{
    "cookie_dir": "",
    "input": false,
    "json_filename": "",
    "output_dir": "",
    "push": true,
    "template": "./cookiecutter-ntc",
    "template_dir": "python",
    "template_ref": "main",
    "pull_request": "update-or-create",
    "post_action": [],
    "disable_post_actions": true,
    "draft": null,
    "drift_managed_branch": "develop"
}
```

Author: bakebot

.cookiecutter.json

@@ -23,11 +23,15 @@
             "pull_request_strategy": "update-or-create",
             "post_actions": [],
             "draft": false,
+<<<<<<< HEAD
 <<<<<<< HEAD
             "baked_commit_ref": "a5add2662f26a3b877635bbf1fd787682414d2bf",
 =======
             "baked_commit_ref": "0bac2e8ca365aea9a730bfc06c5e5029b25dcf50",
 >>>>>>> 1cad760 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
+=======
+            "baked_commit_ref": "1c8e2eb54eafb18e541e80793a2e71d1fcb3b067",
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
             "drift_managed_branch": "develop"
         }
     }

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
           poetry-version: "2.1.3"
       - name: "Linting: ruff format"
@@ -36,7 +36,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
           poetry-version: "2.1.3"
       - name: "Linting: ruff"
@@ -49,7 +49,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
           poetry-version: "2.1.3"
           poetry-install-options: "--only dev,docs"
@@ -63,7 +63,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
           poetry-version: "2.1.3"
       - name: "Checking: poetry lock file"
@@ -76,7 +76,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
           poetry-version: "2.1.3"
       - name: "Linting: yamllint"
@@ -91,13 +91,18 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
+<<<<<<< HEAD
         python-version: ["3.10", "3.11"]  # TODO: Switch back to latest supported Python when https://github.com/networktocode/pyntc/issues/351 is completed
+=======
+        python-version: ["3.10"]
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
     env:
       INVOKE_PYNTC_PYTHON_VER: "${{ matrix.python-version }}"
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
+<<<<<<< HEAD
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
           poetry-version: "2.1.3"
@@ -136,6 +141,9 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+=======
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
         with:
           poetry-version: "2.1.3"
       - name: "Get image version"
@@ -156,6 +164,46 @@ jobs:
           cache-to: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
           build-args: |
             PYTHON_VER=${{ matrix.python-version }}
+<<<<<<< HEAD
+=======
+      - name: "Linting: Pylint"
+        run: "poetry run invoke pylint"
+  pytest:
+    needs:
+      - "check-in-docker"
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.10", "3.14"]
+    runs-on: "ubuntu-latest"
+    env:
+      INVOKE_PYNTC_PYTHON_VER: "${{ matrix.python-version }}"
+    steps:
+      - name: "Check out repository code"
+        uses: "actions/checkout@v4"
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
+        with:
+          poetry-version: "2.1.3"
+      - name: "Get image version"
+        run: "echo INVOKE_PYNTC_IMAGE_VER=`poetry version -s`-py${{ matrix.python-version }} >> $GITHUB_ENV"
+      - name: "Set up Docker Buildx"
+        id: "buildx"
+        uses: "docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2"  # v3.10.0
+      - name: "Build"
+        uses: "docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25"  # v5.4.0
+        with:
+          builder: "${{ steps.buildx.outputs.name }}"
+          context: "./"
+          push: false
+          load: true
+          tags: "${{ env.INVOKE_PYNTC_IMAGE_NAME }}:${{ env.INVOKE_PYNTC_IMAGE_VER }}"
+          file: "./Dockerfile"
+          cache-from: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
+          cache-to: "type=gha,scope=${{ env.INVOKE_PYNTC_IMAGE_NAME }}-${{ env.INVOKE_PYNTC_IMAGE_VER }}-py${{ matrix.python-version }}"
+          build-args: |
+            PYTHON_VER=${{ matrix.python-version }}
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
       - name: "Run Tests"
         run: "poetry run invoke pytest"
   changelog:
@@ -169,7 +217,7 @@ jobs:
         with:
           fetch-depth: "0"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
           poetry-version: "2.1.3"
       - name: "Check for changelog entry"

.github/workflows/prepare_release.yml

@@ -21,6 +21,13 @@ on: # yamllint disable-line rule:truthy rule:comments
         description: "Date of the release YYYY-MM-DD (defaults to today's date in the US Eastern TZ)."
         required: false
         default: ""
+<<<<<<< HEAD
+=======
+      previous_version:
+        description: "The previous version tag to use for generating release notes (defaults to the latest tag or initial commit if no tags exist)."
+        required: false
+        default: ""
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
 
 jobs:
   prepare-release:
@@ -38,7 +45,11 @@ jobs:
           fetch-depth: 0  # Fetch all history for git tags
 
       - name: "Setup environment"
+<<<<<<< HEAD
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+=======
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
         with:
           poetry-version: "2.1.3"
           poetry-install-options: "--with dev"
@@ -53,7 +64,15 @@ jobs:
 
           # 2. Try to get the previous version tag
           # If it fails (no tags), get the hash of the first commit
+<<<<<<< HEAD
           if PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null); then
+=======
+          if [ -n "${{ github.event.inputs.previous_version }}" ]; then
+            PREV_TAG="${{ github.event.inputs.previous_version }}"
+            echo "Using user-specified previous version: $PREV_TAG"
+            echo "PREVIOUS_TAG=$PREV_TAG" >> $GITHUB_ENV
+          elif PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null); then
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
             echo "PREVIOUS_TAG=$PREV_TAG" >> $GITHUB_ENV
             echo "Found previous tag: $PREV_TAG"
           else
@@ -65,9 +84,31 @@ jobs:
 
       - name: "Determine New Version"
         id: "versioning"
+<<<<<<< HEAD
         run: |
           # Perform the bump based on the user input
           poetry version ${{ github.event.inputs.bump_rule }}
+=======
+        env:
+          GH_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+        run: |
+          # Bump the poetry version based on the user input
+          CURRENT_POETRY_VER=$(poetry version --short)
+          set +e  # continue running if the next command fails
+          GITHUB_RELEASE_EXISTS=$(gh release view v$CURRENT_POETRY_VER --json publishedAt --jq '.publishedAt')
+          set -e
+          # Unconditionally bump the version if the current version is alpha0 or beta0
+          if [[ $CURRENT_POETRY_VER == *a0 || $CURRENT_POETRY_VER == *b0 || $CURRENT_POETRY_VER == *rc0 ]]; then
+            poetry version ${{ github.event.inputs.bump_rule }}
+          # If the bump rule is prerelease and a release doesn't already exist in github we don't bump the version
+
+          # This is because we've already bumped to the prerelease version after the previous release
+          elif [[ "${{ github.event.inputs.bump_rule }}" == "prerelease" && "$CURRENT_POETRY_VER" =~ (a|b|rc)[0-9]+$ && -z "$GITHUB_RELEASE_EXISTS" ]]; then
+            echo "Prerelease v$CURRENT_POETRY_VER does not exist in github, using this version"
+          else
+            poetry version ${{ github.event.inputs.bump_rule }}
+          fi
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
 
           # Capture the New version string for use in other steps
           NEW_VER=$(poetry version --short)
@@ -138,7 +179,11 @@ jobs:
           # 7. Save to a temporary file to avoid shell argument length limits
           echo "$FINAL_NOTES" > ../consolidated_notes.md
 
+<<<<<<< HEAD
       - name: "Generate Release Notes"
+=======
+      - name: "Generate App Release Notes and update mkdocs.yml"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
         run: "poetry run inv generate-release-notes --version '${{ env.NEW_VERSION }}' --date '${{ env.RELEASE_DATE }}'"
 
       - name: "Commit Changes and Push"

.github/workflows/release.yml

@@ -4,6 +4,10 @@ on:  # yamllint disable-line rule:truthy rule:comments
   release:
     types: ["published"]
 
+env:
+  POETRY_VERSION: "2.1.3"
+  PYTHON_VERSION: "3.12"
+
 jobs:
   build:
     name: "Build package with poetry"
@@ -14,9 +18,16 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v7"
         with:
+<<<<<<< HEAD
           poetry-version: "2.1.3"
           python-version: "3.12"
+=======
+          poetry-version: "${{ env.POETRY_VERSION }}"
+          python-version: "${{ env.PYTHON_VERSION }}"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
           poetry-install-options: "--no-root"
+      - name: "Build Documentation"
+        run: "poetry run invoke build-and-check-docs"
       - name: "Run Poetry Build"
         run: "poetry build"
 
@@ -56,15 +67,21 @@ jobs:
     if: "startsWith(github.ref, 'refs/tags/v')"
     needs: "build"
     environment: "pypi"
+<<<<<<< HEAD
     # IMPORTANT: this permission is mandatory for trusted publishing.
     permissions:
+=======
+    permissions:
+      # IMPORTANT: this permission is mandatory for Trusted Publishing
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
       id-token: "write"
     steps:
       - name: "Retrieve built package from cache"
         uses: "actions/download-artifact@v4"
         with:
           name: "distfiles"
           path: "dist/"
+
       - name: "Publish package distributions to PyPI"
         uses: "pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e"  # v1.13.0
 
@@ -107,12 +124,17 @@ jobs:
     permissions:
       contents: "write"
       pull-requests: "write"
+<<<<<<< HEAD
     name: "Create a PR from main into develop"
+=======
+    name: "${{ github.event.release.target_commitish == 'main' && 'Create a PR from main into develop' || format('Create a PR to merge into {0}', github.event.release.target_commitish) }}"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
     needs:
       - "publish-github"
       - "publish-pypi"
     runs-on: "ubuntu-latest"
     steps:
+<<<<<<< HEAD
       - name: "Checkout main"
         uses: "actions/checkout@v4"
         with:
@@ -126,16 +148,45 @@ jobs:
           poetry-install-options: "--no-root"
 
       - name: "Create release branch from main"
+=======
+      - name: "Checkout source branch"
+        uses: "actions/checkout@v4"
+        with:
+          ref: "${{ github.event.release.target_commitish }}"
+          fetch-depth: 0
+
+      - name: "Setup environment"
+        uses: "networktocode/gh-action-setup-poetry-environment@v7"
+        with:
+          poetry-version: "${{ env.POETRY_VERSION }}"
+          poetry-install-options: "--no-root"
+
+      - name: "Create release branch and bump version"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
         id: "branch"
         run: |
 
           git config user.name "${{ github.actor }}"
           git config user.email "${{ github.actor }}@users.noreply.github.com"
 
+<<<<<<< HEAD
           TAG_NAME="${{ github.event.release.tag_name }}"
           VERSION="${TAG_NAME#v}"
 
           BRANCH_NAME="release-${VERSION}-to-develop"
+=======
+          SOURCE_BRANCH="${{ github.event.release.target_commitish }}"
+          if [ "$SOURCE_BRANCH" = "main" ]; then
+            TARGET_BRANCH="develop"
+          else
+            TARGET_BRANCH="$SOURCE_BRANCH"
+          fi
+
+          TAG_NAME="${{ github.event.release.tag_name }}"
+          VERSION="${TAG_NAME#v}"
+
+          BRANCH_NAME="release-${VERSION}-to-${TARGET_BRANCH}"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
 
           # Ensure release branch doesn't already exist
           if git rev-parse --verify origin/$BRANCH_NAME > /dev/null 2>&1; then
@@ -145,18 +196,43 @@ jobs:
 
           git checkout -b "$BRANCH_NAME"
 
+<<<<<<< HEAD
           poetry version prepatch
+=======
+          poetry version prerelease
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
           git add pyproject.toml && git commit -m "Bump version"
           git push origin "$BRANCH_NAME"
 
           echo "branch_name=$BRANCH_NAME" >> $GITHUB_OUTPUT
+<<<<<<< HEAD
 
       - name: "Create Pull Request to develop"
+=======
+          echo "target_branch=$TARGET_BRANCH" >> $GITHUB_OUTPUT
+
+      - name: "Create Pull Request"
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
         env:
           GH_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
         run: |
           gh pr create \
+<<<<<<< HEAD
             --title "Post release ${{ github.event.release.tag_name }} to develop" \
+=======
+            --title "Post release ${{ github.event.release.tag_name }} to ${{ steps.branch.outputs.target_branch }}" \
+            --body "Please do a merge commit." \
+            --base "${{ steps.branch.outputs.target_branch }}" \
+            --head "${{ steps.branch.outputs.branch_name }}"
+
+      - name: "Create Pull Request"
+        if: "steps.branch.outputs.branch_name != ''"
+        env:
+          GH_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+        run: |
+          gh pr create \
+            --title "Sync release notes from ${{ github.event.release.target_commitish }} (${{ github.event.release.tag_name }}) to develop" \
+>>>>>>> 45de4a7 (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
             --body "Please do a merge commit." \
             --base "develop" \
             --head "${{ steps.branch.outputs.branch_name }}"