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

feat(internal/gapicgen): change commit formatting to match standard #3500

Merged
merged 5 commits into from Jan 11, 2021

Conversation

@codyoss
Copy link
Member

@codyoss codyoss commented Jan 5, 2021

Changing the commit formatting so that it can be parsed as a footer
with a conventional commits parser. Here is an example of what a
commit looked like previously:

And what it will look like now:

docs(dialogflow): update comments on parameters and validation result.
PiperOrigin-RevId: 348673154
Source-Link: googleapis/googleapis@0795e3f

Changing the commit formatting so that it can be parsed as a footer
with a conventional commits parser. Here is an example of what a
commit looked like previously:

  - docs(dialogflow): update comments on parameters and validation result.

  PiperOrigin-RevId: 348673154
  Source-Link: googleapis/googleapis@0795e3f

And what it will look like now:

  docs(dialogflow): update comments on parameters and validation result.
    PiperOrigin-RevId: 348673154
    Source-Link: googleapis/googleapis@0795e3f
@codyoss codyoss requested a review from googleapis/yoshi-go-admins as a code owner Jan 5, 2021
@google-cla google-cla bot added the cla: yes label Jan 5, 2021
@codyoss
Copy link
Member Author

@codyoss codyoss commented Jan 5, 2021

cc @bcoe . Will wait to merge this until the parser work is done.

Copy link
Collaborator

@tbpg tbpg left a comment

High level question: looking at https://www.conventionalcommits.org/en/v1.0.0/, it seems like there should be an empty line between the first line and the next?

internal/gapicgen/generator/git.go Outdated Show resolved Hide resolved
@codyoss
Copy link
Member Author

@codyoss codyoss commented Jan 7, 2021

@bcoe
Copy link
Collaborator

@bcoe bcoe commented Jan 7, 2021

High level question: looking at https://www.conventionalcommits.org/en/v1.0.0/, it seems like there should be an empty line between the first line and the next?

@tbpg as we formalize the grammar, I've been advocating that we allow single newlines, to protect against human error.

@codyoss codyoss requested a review from tbpg Jan 11, 2021
@tbpg
tbpg approved these changes Jan 11, 2021
@codyoss codyoss merged commit d1e3d46 into googleapis:master Jan 11, 2021
3 checks passed
3 checks passed
@google-cla
cla/google All necessary CLAs are signed
@conventional-commit-lint-gcf
conventionalcommits.org
Details
@kokoro-team
kokoro Kokoro CI build successful
Details
@codyoss codyoss deleted the codyoss:cc-footer branch Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants