Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix "Bump changelog on release" GH Action #1188

Merged
merged 4 commits into from
Jan 8, 2024

Conversation

chrysle
Copy link
Contributor

@chrysle chrysle commented Jan 4, 2024

  • I have added an entry to docs/changelog.md

Summary of changes

Basically I made sure I'm allowed to bypass the branch protection rules and configured the action to commit with my identity.
I think we shouldn't remove the branch protection.

This ought to close #1185.

Test plan

Tested by running

# command(s) to exercise these changes

@chrysle chrysle force-pushed the fix-bump-changelog-action branch from f6e2fb5 to 3e09187 Compare January 4, 2024 15:50
@henryiii
Copy link
Contributor

henryiii commented Jan 5, 2024

Wouldn't it be better to have it make a PR? That's what I was intending to do later.

@chrysle
Copy link
Contributor Author

chrysle commented Jan 5, 2024

@henryiii I thought merging that every time would mean increased effort, but I guess you're right. If you don't insist on doing it, I could also configure it in this PR (I'd use GH CLI).

@chrysle chrysle force-pushed the fix-bump-changelog-action branch from a79aae0 to 7a69441 Compare January 5, 2024 17:27
@henryiii
Copy link
Contributor

henryiii commented Jan 5, 2024

You are welcome to do it. :) I think you can use the gh CLI, I've intended to try with that, I've used https://github.com/peter-evans/create-pull-request before and it works well. You do have to close and reopen to trigger CI unless you set up a bot, which I haven't done yet.

https://github.com/scientific-python/cookie/blob/main/.github/workflows/bump.yml is one I've set up, another is https://github.com/pypa/cibuildwheel/blob/main/.github/workflows/update-dependencies.yml which does have the bot.

@chrysle
Copy link
Contributor Author

chrysle commented Jan 5, 2024

I've already pushed an attempt, could you have a look?

@henryiii
Copy link
Contributor

henryiii commented Jan 5, 2024

I haven't tried gh for this, so I don't want to guarantee anything, but it looks correct and like what I would have tried, I think.

@chrysle chrysle force-pushed the fix-bump-changelog-action branch 4 times, most recently from dc21064 to a3f1192 Compare January 6, 2024 19:30
@chrysle chrysle force-pushed the fix-bump-changelog-action branch from a3f1192 to 6684eb2 Compare January 6, 2024 19:55
.github/workflows/tests.yml Outdated Show resolved Hide resolved
.github/workflows/tests.yml Outdated Show resolved Hide resolved
@chrysle
Copy link
Contributor Author

chrysle commented Jan 7, 2024

@henryiii @dukecat0 I don't seem to be able to test this fully on my fork (see this actions run), but judging by what does work there, this should be ready.

Copy link
Contributor

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gaborbernat gaborbernat merged commit 0ea5ed6 into pypa:main Jan 8, 2024
14 checks passed
@henryiii
Copy link
Contributor

Do you need the pull-requests: write permission? I noticed I have that one one that uses peter-evans/create-pull-request@v5. (I'm not sure how to nicely do a "Make a pull request only if changed", or I would have projects to test out gh pr in CI).

https://github.com/scientific-python/cookie/blob/57fc35295e5cfc79b9152a82d183cb8c73c6865b/.github/workflows/bump.yml#L9

@gaborbernat
Copy link
Contributor

@henryiii
Copy link
Contributor

Fix in #1202, it was missing pull-requests: write.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix bump changelog action
4 participants