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: add default chore: prefix to upgrade action #226

Closed
wants to merge 1 commit into from

Conversation

debkanchan
Copy link

@debkanchan debkanchan commented Feb 17, 2024

Currently upgrade actions doesn't use semantic PR title. This can cause problems for orgs who rely on conventional commit or use tools like semantic PR causing checks to fail. This PR adds a default prefix value of chore: to PR title.

@debkanchan
Copy link
Author

@TylerJang27 review plis?

@TylerJang27
Copy link
Contributor

Hi @debkanchan, we recognize the need to follow conventions established by other tools. With that being said, you should be able to just pass in an inputs.prefix value of chore: . I'm not sure if we want to change the default behavior here. I'm curious to hear your thoughts and more about your use case.

@debkanchan
Copy link
Author

@TylerJang27 IMHO this is a backwards compatible change that makes it 0 setup for orgs who follow semantic comments which is a lot of orgs. So for them there's no setup. And for orgs which don't use any semantics commits they can just ignore it making it backwards compatible. For the very few orgs which have specific prefix in mind they can customise it.

@TylerJang27
Copy link
Contributor

@debkanchan I spoke with the team about this. For now, we're going to keep it as an optional input with no prefix. Some additional rationale:

  • We're in favor of the semantic commit style, but before we change the default we would want to evaluate supporting it holistically, across the board with our other products. We'll reevaluate this in the future
  • Using something like dependabot as a model, we would prefer to be aligned in not having a default prefix for the time being
  • Users will still be able to specify an optional prefix. We may update the docs to highlight this more explicitly

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

Successfully merging this pull request may close these issues.

2 participants