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: semantic PR title via conventional commits #3536

Merged
merged 4 commits into from
Nov 15, 2023
Merged

Conversation

scarf005
Copy link
Member

@scarf005 scarf005 commented Nov 3, 2023

Purpose of change

Describe the solution

install https://github.com/apps/semantic-prs to enforce PR title

Describe alternatives you've considered

pain

Testing

used them on other projects, they work as intended

Additional context

Q: Nooo, do i have to edit all those PR titles, i don't know how to do that
A: No worries, i've been doing that manually for months and this app just prevents me from overlooking one

Q: Then can i just write whatever on PR title and you'll fix it for me?
A: It'd be very nice if you could follow conventional commits, tho.

Checklist

  • reword automated i18n PR title
  • remove ## Summary section
  • think up of better category
  • update docs

Additional Context

image

Semantic PR bot also needs to be approved to enforce the PR title consistency.

@scarf005 scarf005 force-pushed the ci-semantic-pr branch 3 times, most recently from d241ed1 to 684f224 Compare November 11, 2023 02:54
@scarf005 scarf005 marked this pull request as ready for review November 12, 2023 23:25
If the PR is a port or adaptation of DDA content, please indicate it by adding port in PR title, like:
feat(port): <feature name> from DDA

COMMENTS: Please remove all comments and unrelevent sections from this template before submitting your PR.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if I understand this bit.
Also, seems to be a typo: unrelevAnt.

Copy link
Member Author

Choose a reason for hiding this comment

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

oh, i meant pruning html comments in PR body, as they get included in PR body previews (e.g on notification)

Copy link
Contributor

@olanti-p olanti-p Nov 15, 2023

Choose a reason for hiding this comment

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

Before #3519, the template used to ask to remove the comments, but turns out ~40% of PRs don't do that anyway (either laziness or just avoiding removing something that may become relevant later), so we're stuck with them until GitHub introduces issue forms, but for PRs.

@Coolthulhu
Copy link
Member

Looks good to me, I'll approve the semantic PR thing for now. But I'd like to know what exactly is the "no comment" section about - I hope it doesn't mean that the submitter will have to manually prune the PR notes.

i think this could be better expressed as another PR.
@scarf005 scarf005 added this pull request to the merge queue Nov 14, 2023
Merged via the queue into upload with commit 5635285 Nov 15, 2023
12 of 15 checks passed
@scarf005 scarf005 deleted the ci-semantic-pr branch November 15, 2023 00:40
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