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

chore: Add semantic PR Linter #1136

Merged
merged 20 commits into from
Jan 1, 2024
Merged

chore: Add semantic PR Linter #1136

merged 20 commits into from
Jan 1, 2024

Conversation

DaveSkender
Copy link
Owner

@DaveSkender DaveSkender commented Dec 31, 2023

Adding enforcement of semantic conventional commit standards for PR titles.

to do

  • update settings, see action docs
    • enforce first letter capitalized, or sentence case
  • update PR template with other standards, like BREAKING CHANGE
  • consider also Semantic Release convention tooling
  • copy to other repos

Note: to test in this initial PR, temporarily change on: pull_request_target to on: pull_request

initial configuration

feat(ui): Add `Button` component
^    ^    ^
|    |    |__ Subject
|    |_______ Scope
|____________ Type

In our implementation:

  • types and scopes requirements were not altered, using default settings and values (scope is not required, not do we recommend using it).
  • subject was adjusted to required that it starts with a Capitalized letter, for example feat: Poodle doodle would pass, but feat: poodle doodle would fail. This implicitly also means subject cannot start with symbols or numbers.

Signed-off-by: Dave Skender <[email protected]>
Copy link

github-actions bot commented Dec 31, 2023

✔️ Tests 718 / 718 - passed in 6.6s
✔️ Coverage 96.47% - passed with 95% threshold
📏 5315 / 5318 lines covered 🌿 2309 / 2585 branches covered
🔍 click here for more details

✏️ updated for commit 5cd0db1

@DaveSkender DaveSkender marked this pull request as ready for review December 31, 2023 11:49
@DaveSkender
Copy link
Owner Author

Why is it not triggered?

@DaveSkender DaveSkender marked this pull request as draft December 31, 2023 11:51
Signed-off-by: Dave Skender <[email protected]>
@DaveSkender DaveSkender changed the title Create semantic-pr-linter chore: add semantic-pr-linter Dec 31, 2023
Signed-off-by: Dave Skender <[email protected]>
@DaveSkender DaveSkender marked this pull request as ready for review December 31, 2023 12:00
@DaveSkender DaveSkender marked this pull request as draft December 31, 2023 12:01
@DaveSkender
Copy link
Owner Author

DaveSkender commented Dec 31, 2023

Okay, it works, just not on this initial PR when using on: pull_request_target.

Copy link

github-actions bot commented Jan 1, 2024

Hey there and thank you for opening this pull request! 👋🏼

It looks like your proposed title needs to be adjusted.

🚩 The subject "add semantic-pr-linter" found in the pull request title "chore: add semantic-pr-linter" didn't match the configured pattern. Please ensure that the subject starts with an uppercase character.

Pull request title naming convention

Our PR title name taxonomy is type: Subject, where type is typically feat, fix, or chore and subject is a noun that starts with a capitalized letter. The chore type usually has a subject that starts with an action verb like Add or Update. Examples:

feat: Admin portal login
fix: Divide by zero bug in SMA
chore: Update user docs

See the Conventional Commits specification for more information.

@DaveSkender DaveSkender changed the title chore: add semantic-pr-linter add semantic-pr-linter Jan 1, 2024
@DaveSkender DaveSkender changed the title add semantic-pr-linter chore: add semantic-pr-linter Jan 1, 2024
@DaveSkender DaveSkender changed the title chore: add semantic-pr-linter add semantic-pr-linter Jan 1, 2024
@DaveSkender DaveSkender changed the title add semantic-pr-linter chore: add semantic-pr-linter Jan 1, 2024
@DaveSkender DaveSkender marked this pull request as ready for review January 1, 2024 04:23
@DaveSkender DaveSkender changed the title chore: add semantic-pr-linter chore: Add semantic-pr-linter Jan 1, 2024
@DaveSkender DaveSkender enabled auto-merge (squash) January 1, 2024 04:24
@DaveSkender DaveSkender changed the title chore: Add semantic-pr-linter chore: Add semantic PR Linter Jan 1, 2024
@DaveSkender DaveSkender merged commit 17d5ab8 into main Jan 1, 2024
3 checks passed
@DaveSkender DaveSkender deleted the semantic-pr branch January 1, 2024 04:26
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant