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

feat: add baseBranch option #373

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

prenaissance
Copy link

Closes #368

Change summary

This change adds a new action input baseBranch, which allows specifying the branch on which the PR will be opened on. This is useful for hotfixes. In my case, I trigger a release on merging to main, and this change would allow me to open a PR straight to main with the cherry-picked changes.

Specifications

A new input, baseBranch, can be specified to open the PR onto that branch. If not specified, the behavior will be as before, the PR would be opened on the branch the action runs on.

Example

Here's how running a hotfix workflow would look like:

hotfix_action

The full workflow can be seen here https://github.com/prenaissance/changesets-test/blob/master/.github/workflows/changesets.yml

Copy link

changeset-bot bot commented Jun 3, 2024

⚠️ No Changeset found

Latest commit: 31ff97e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

@trueberryless trueberryless left a comment

Choose a reason for hiding this comment

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

LGTM 🎉 after I took a quick look

Very cool improvement imho.

Could you maybe add the explaination of this change into the README.md tho? So the documentation is up-to-date...

@prenaissance
Copy link
Author

Accidentally pushed the wrong branch and the PR was closed automatically

@prenaissance prenaissance reopened this Nov 30, 2024
@prenaissance
Copy link
Author

Thanks for the feedback @trueberryless. I added the new action input in the README. Let me know if an example with a full workflow is needed.

Copy link

@trueberryless trueberryless left a comment

Choose a reason for hiding this comment

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

Looks good to me 🎉

I'll leave the decision for an additional example with the baseBranch option to the actual maintainers, they know it the best...

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.

Suggestion: add input to specify the target branch
2 participants