fix: update release workflow to create PR instead of pushing directly… (netbox-community#407)

* fix: update release workflow to create PR instead of pushing directly to protected main branch

- Create a branch for release updates
- Open a pull request instead of direct push
- Auto-approve and merge the PR with squash
- Requires enabling auto-merge in repository settings

* fix: resolve yamllint errors in release workflow

- Quote 'on' key to avoid truthy value warning
- Remove trailing spaces on lines 97, 101, and 104

* feat: add complete CHANGELOG automation from feature/automatic-releases

- Add scripts/update-changelog-from-release.sh for automatic changelog updates
- Add CHANGELOG.md with complete release history
- Fix sed command to use pipe separator for better compatibility
- Integrate changelog updates into PR-based release workflow

---------

Co-authored-by: Pablo Garcia Miranda <[email protected]>

Author: pablogarciamiranda

.github/workflows/release.yaml

@@ -30,7 +30,7 @@ jobs:
         run: |
           # Get tag name and message
           TAG_NAME=${GITHUB_REF#refs/tags/}
-          TAG_MESSAGE=$(git tag -n1 "$TAG_NAME" | sed "s/^$TAG_NAME[[:space:]]*//")
+          TAG_MESSAGE=$(git tag -n1 "$TAG_NAME" | sed "s|^$TAG_NAME[[:space:]]*||")
 
           # If tag message is empty, use a default
           if [ -z "$TAG_MESSAGE" ]; then
@@ -64,16 +64,43 @@ jobs:
         run: |
           ./scripts/bump-version.sh "${{ steps.tag_data.outputs.TAG_NAME }}"
 
+      - name: Update CHANGELOG.md
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          ./scripts/update-changelog-from-release.sh "${{ steps.tag_data.outputs.TAG_NAME }}"
+
       - name: Commit and push changes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           # Check if there are changes to commit
           if git diff --quiet; then
             echo "No changes to commit"
             exit 0
           fi
 
-          git add config/manager/kustomization.yaml
-          git commit -m "chore: bump version to ${{ steps.tag_data.outputs.TAG_NAME }} [skip ci]"
+          # Create a new branch for the changes
+          BRANCH_NAME="release-updates-${{ steps.tag_data.outputs.TAG_NAME }}"
+          git checkout -b "$BRANCH_NAME"
+
+          git add config/manager/kustomization.yaml CHANGELOG.md
+          git commit -m "chore: bump version to ${{ steps.tag_data.outputs.TAG_NAME }} and update changelog [skip ci]"
+
+          # Push the branch and create PR
+          git push origin "$BRANCH_NAME"
+          PR_URL=$(gh pr create \
+            --title "chore: bump version to ${{ steps.tag_data.outputs.TAG_NAME }} and update changelog" \
+            --body "Automated version bump and changelog update for release ${{ steps.tag_data.outputs.TAG_NAME }}" \
+            --head "$BRANCH_NAME" \
+            --base main)
+
+          # Extract PR number from URL
+          PR_NUMBER=$(echo "$PR_URL" | sed 's/.*\/pull\///')
+          echo "Created PR #$PR_NUMBER: $PR_URL"
+
+          # Auto-approve the PR
+          gh pr review "$PR_NUMBER" --approve --body "Auto-approving automated release PR"
 
-          # Push to main branch
-          git push origin HEAD:main
+          # Enable auto-merge and merge the PR
+          gh pr merge "$PR_NUMBER" --auto --squash --delete-branch