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

gitlint: Allow trivial changes to be without reference (SOC-9559) #3518

Merged
merged 2 commits into from
Jul 3, 2019

Conversation

rsalevsky
Copy link
Contributor

The author of a commit should make a conscious decision to either add a
reference or not. Adding trivial instead of bsc or SOC enables this.
This change prevents that adding a refernce is forgotten as the
syntax requires to think about it.

See #3509 for more details.

nicolasbock
nicolasbock previously approved these changes Jul 1, 2019
bmwiedemann
bmwiedemann previously approved these changes Jul 1, 2019
@@ -8,13 +8,10 @@ line-length=80
words=wip,WIP

[title-match-regex]
regex=^(?!SOC).*\(((bsc#|SOC-)[0-9]+(,\s)?)+\)$
regex=^(?!SOC).*\((((bsc#|SOC-)[0-9]+(,\s)?)+|trivial)\)$
Copy link
Contributor

Choose a reason for hiding this comment

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

is there corresponding filtering on "(trivial)" in the changelog extraction code? because I think we shouldn't have this in customer visible changelogs..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why not? We could use a different word if this is what you want to say.

@skazi0
Copy link
Member

skazi0 commented Jul 2, 2019

@rsalevsky maybe there should be more keywords included like "typo", "spelling", etc.

EDIT: example which would fall into this category: crowbar/crowbar-core#1873

@rsalevsky rsalevsky dismissed stale reviews from bmwiedemann and nicolasbock via 4fcc035 July 2, 2019 10:01
@rsalevsky rsalevsky force-pushed the gitlint2 branch 2 times, most recently from 4fcc035 to db96f0a Compare July 2, 2019 10:01
@rsalevsky
Copy link
Contributor Author

rsalevsky commented Jul 2, 2019

Added:

  • trivial -> simple unplanned changes
  • noref -> more complex unplanned changes
  • typo -> typo fixes only

@skazi0
Copy link
Member

skazi0 commented Jul 2, 2019

@rsalevsky now you can fix the typo in your commit title :oD (refer[e]nce)

Rick Salevsky added 2 commits July 2, 2019 12:15
The author of a commit should make a conscious decision to either add a
reference or not. Adding trivial instead of bsc or SOC enables this.
This change prevents that adding a refernce is forgotten as the
syntax requires to think about it.

trivial -> simple unplanned changes
noref -> more complex unplanned changes
typo -> typo fixes only

See
SUSE-Cloud#3509 (comment)
for more details.
This check prevented external contributions.
@rsalevsky rsalevsky changed the title gitlint: Allow trivial changes to be without refernce (SOC-9559) gitlint: Allow trivial changes to be without reference (SOC-9559) Jul 2, 2019
Copy link
Member

@skazi0 skazi0 left a comment

Choose a reason for hiding this comment

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

lgtm

@rsalevsky rsalevsky merged commit eb2909b into SUSE-Cloud:master Jul 3, 2019
@rsalevsky rsalevsky deleted the gitlint2 branch July 3, 2019 09:39
@dirkmueller
Copy link
Contributor

@rsalevsky I really think this is to some extend the responsibility of a reviewer as well to check for references. if references are forgotten - its not the end of the world, they can be added to the .changes file afterwards as well.

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.

6 participants