changelog notes protected branch

[mkatsanto]

Describe the bug
The CHANGELOG.md is not working properly in this workflow. The issue is that this action is adding the history of commits to the CHANGELOG.md and then pushes the commit to the protected-dev branch, which is not allowed. The only workarounds for this is to allow this action to act as an administrator or create some ssh key that allows it to force push to the protected dev branch. The question is, do we want that? The other alternative would be to add the commit to each of the PRs upon the pull request. This would not need to bypass any protections, but I am not sure how feasible it is https://github.com/requarks/changelog-action.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

[uniqueg]

Hi @mkatsanto,

Creating a personal access token from an admin account is the less appealing solution for me. The other one is fine though.

I have first created a zavolab bot account and added it as a member to our organization. I have then given the bot account permissions to force push to the dev branch of this repo. From the bot account, I have then created a personal access token for the user with the repo and workflow scopes (as described here). Finally, I have created an organization secret AUTO_COMMIT with the value of that token (so we can use that token in every repository where we need auto commit features).

I think if you follow the instructions in the git-auto-commit-action docs, it will hopefully work. In particular, you need to add/replace:

- uses: actions/checkout@v3
  with:
    token: ${{ secrets.AUTO_COMMIT }}

Note that you should probably increase the actions/checkout version to v3, it's currently at v2.

And:

- uses: stefanzweifel/git-auto-commit-action@v4
  with:
    ...
    push_options: --force

[uniqueg]

It might be working now, but I couldn't test it, because all of the commits in the new release are somehow excluded from the automated changelog:

sing input tag: v1.0.0
Using latest tag: v1.0.0
Using previous tag: v1.0.0-rc.1
[OK] Commit bc41e3dcf420946358f16ebf5a87a5d724590069 of type docs - deploy dedicated docs pages (#175)
[OK] Commit c95abd5a458d6867f7b88[15](https://github.com/zavolanlab/zarp/actions/runs/14585751131/job/40911756090#step:3:16)6b850a9a4a2daebdb of type docs - add ZARP poster to info materials (#176)
[OK] Commit 89969ff465f29025c59ff47da2a88da2879f5797 of type build - major dependencies update (#181)
[OK] Commit 218a07879d5b80f687a27e8a8dd27d29733b6215 of type build - add Dockerfile (#188)
[OK] Commit 337ced67cb56ccaf1bfc2acc77aaf87b7c8c5874 of type docs - add extensive externally hosted docs (#[17](https://github.com/zavolanlab/zarp/actions/runs/14585751131/job/40911756090#step:3:18)7)
[OK] Commit e2288df00aed9ee4eb4f621737ec39ba9dccbcf8 of type ci - allow workflow to force push CHANGELOG (#[18](https://github.com/zavolanlab/zarp/actions/runs/14585751131/job/40911756090#step:3:19)9)
Selected Types: feat, feature, fix, bugfix, perf, refactor, test, tests, chore
Warning: Nothing to add to changelog because of excluded types.

Also, the AUTO_COMMIT PAT of the Zavolab account was refreshed and will expire in 366 days.