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

ci: convert semantic pr title check to use action #5071

Merged

Conversation

thephez
Copy link
Collaborator

@thephez thephez commented Nov 3, 2022

Issue being fixed or feature implemented

The previously used service https://github.com/zeke/semantic-pull-requests was deprecated by the time we actually updated the master branch. This converts to using a GitHub action to enforce conventional commit syntax for PR titles in alignment with our contributing guide.

Notes

What was done?

Although the contributing guide indicated conventional commit syntax should be used for PR titles, nothing was enforcing it. This PR adds a GitHub Action (semantic-pull-request) that checks PR titles to make sure they match the relevant format and type/scope criteria.

How Has This Been Tested?

Tested using thephez#5 in my fork of this repo. See https://github.com/thephez/dash/actions/workflows/semantic-pull-request.yml for results of various attempts.

Breaking Changes

N/A

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone (recommend the next release)

@thephez thephez changed the title ci: add semantic pr title check action ci: convert semantic pr title check to use action Nov 3, 2022
trivial
backport
# Configure which scopes are allowed (newline delimited).
scopes: |
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's possible to eliminate the scopes section here. In that case it would check the types, but allow any scope. I don't think we want to do that, but it's an option 🤷‍♂️

@UdjinM6 UdjinM6 added this to the 18.2 milestone Nov 5, 2022
UdjinM6
UdjinM6 previously approved these changes Nov 5, 2022
Copy link

@UdjinM6 UdjinM6 left a comment

Choose a reason for hiding this comment

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

utACK

.github/workflows/semantic-pull-request.yml Outdated Show resolved Hide resolved
Co-authored-by: UdjinM6 <UdjinM6@users.noreply.github.com>
Copy link
Member

@PastaPastaPasta PastaPastaPasta left a comment

Choose a reason for hiding this comment

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

utACK for squash merge

@PastaPastaPasta PastaPastaPasta merged commit 76d70bd into dashpay:develop Nov 7, 2022
@thephez thephez deleted the semantic-pr-title-check-action branch November 7, 2022 14:45
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.

3 participants