chore(prlinter): added commit message validation #6573

iliapolo · 2020-03-03T22:15:14Z

This PR (hopefully) standardizes the commit messages that end up on master when mergify squash merges our PR's.

What we have know

Currently, the commit message that mergify uses is simply the default squash message provided by GitHub. That has the following heuristic:

If the PR contains one commit - just use that commit.
If the PR contains multiple commits, use the PR title as the first line, and combine all the commit titles as the rest of the message.

This is problematic:

If the PR contains one commit, suddenly that commit has to follow conventional commits, which we don't require normally.
If the PR has multiple commits, and one of them has breaking changes in it, that commit has to be last. But there is no way of actually enforcing that apart from manually squashing all the commits.
Aggregating multiple commits from a branch into the commit message usually results in a cluttered commit message.

What will change

Instead of relying on GitHub, we can force mergify to use a section in the PR description called Commit Message.

See https://doc.mergify.io/actions.html#commit-message-and-squash-method.

This means that all we need to do is validate that the section contains the content we want it to contain, which is what the github action in this PR does.

Here is an example of what the PR should look like: #6553

Caveat

Apparently, GitHub doesn't group check runs for the same commit hash. That means that every time a non commit event triggers an action, it will add a duplicate. This means we will have as many duplicates as the amount of changes done to the PR title/description.

You can see this PR as an example.

And the GitHub issue: https://github.saobby.my.eu.orgmunity/t5/GitHub-Actions/duplicate-checks-on-pull-request-event/td-p/33157

Commit Message

chore(prlinter): added commit message validation (#6573)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation · 2020-03-03T22:57:22Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d04951b
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-03T23:03:40Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d14a340
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-03T23:29:05Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 0b5e9a3
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-04T00:58:07Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 8fc6cf0
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-04T01:03:15Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: cb885ff
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-04T01:29:34Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 11c6575
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

…e PR template

aws-cdk-automation · 2020-03-04T12:17:21Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 38bb3d9
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-04T13:09:47Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 1521da0
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

iliapolo · 2020-03-04T16:40:12Z

Blocking the merge of this PR until we verify the duplicate checks don't mess with mergify.

iliapolo · 2020-03-08T07:07:24Z

@eladb The action causes mergify to break because mergify doesn't look for the last check, but instead looks for any check.

I would still like to merge this PR just for the sake of the PR template, leave the validation code in there but simply not invoke the action until we sort through the mergify problems.

thoughts?

…terminator

aws-cdk-automation · 2020-03-08T07:32:52Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: b950350
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T07:55:30Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 2558942
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T07:58:11Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 5432913
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T08:08:43Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 7ae738c
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T10:28:11Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d97e621
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T10:28:52Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 853f2ee
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T10:31:21Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 6c44acb
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-03-08T10:37:42Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2020-03-08T10:48:17Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 3033858
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T11:27:58Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 297849a
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2020-03-08T11:28:46Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: c1c8614
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-03-08T11:28:53Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

This reverts commit 2f75318.

added commit message validation

d04951b

mergify bot added the contribution/core This is a PR that came from AWS. label Mar 3, 2020

iliapolo added 3 commits March 4, 2020 00:18

change prlinter triggers

d14a340

reduce triggers

0b5e9a3

added commit-message success condition to mergify

892b68b

iliapolo added 3 commits March 4, 2020 02:09

refactoring

cb885ff

refactoring

8fc6cf0

skip dependabot PR's

11c6575

iliapolo added 5 commits March 4, 2020 11:25

mid work

f4c6128

ignore PR's that are labeled with no-squash

fdda3b9

update contrib guide with new PR instructions

38bb3d9

use only header as message terminator, just like mergify

0bb21c0

replace contrib guide section about PR formatting with a change to th…

1521da0

…e PR template

iliapolo added the pr/do-not-merge This PR should not be merged at this time. label Mar 4, 2020

eladb approved these changes Mar 4, 2020

View reviewed changes

SomayaB assigned iliapolo Mar 4, 2020

remove action for now since it causes mergify to break

b950350

iliapolo added 2 commits March 8, 2020 09:11

dont include additioanl markdown and use 'End Commit Message' as the …

2558942

…terminator

we dont actually autovalidate for now

7ae738c

fix team name

5432913

iliapolo added 4 commits March 8, 2020 11:45

revert trigger changes

d97e621

remove mergify rule

853f2ee

fix steps links

6c44acb

bring back clarification about conventional commit for pr title

3033858

eladb approved these changes Mar 8, 2020

View reviewed changes

iliapolo removed the pr/do-not-merge This PR should not be merged at this time. label Mar 8, 2020

mergify bot added 2 commits March 8, 2020 10:45

Merge branch 'master' into epolon/prlinter-validate-commit-message

297849a

Merge branch 'master' into epolon/prlinter-validate-commit-message

c1c8614

mergify bot merged commit 2f75318 into master Mar 8, 2020

mergify bot deleted the epolon/prlinter-validate-commit-message branch March 8, 2020 11:28

eladb pushed a commit that referenced this pull request Mar 9, 2020

chore(prlinter): added commit message validation (#6573)

5fda71a

horsmand pushed a commit to horsmand/aws-cdk that referenced this pull request Mar 9, 2020

chore(prlinter): added commit message validation (aws#6573)

e1a4da9

iliapolo added a commit that referenced this pull request Mar 11, 2020

Revert "chore(prlinter): added commit message validation (#6573) "

ec47e89

This reverts commit 2f75318.

iliapolo added a commit that referenced this pull request Mar 11, 2020

chore(prlinter): revert commit message validation from (#6573) (#6678)

c90fe9b

This reverts commit 2f75318.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(prlinter): added commit message validation #6573

chore(prlinter): added commit message validation #6573

iliapolo commented Mar 3, 2020 •

edited

Loading

aws-cdk-automation commented Mar 3, 2020

aws-cdk-automation commented Mar 3, 2020

aws-cdk-automation commented Mar 3, 2020

aws-cdk-automation commented Mar 4, 2020

aws-cdk-automation commented Mar 4, 2020

aws-cdk-automation commented Mar 4, 2020

aws-cdk-automation commented Mar 4, 2020

aws-cdk-automation commented Mar 4, 2020

iliapolo commented Mar 4, 2020

iliapolo commented Mar 8, 2020 •

edited

Loading

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

mergify bot commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

mergify bot commented Mar 8, 2020

chore(prlinter): added commit message validation #6573

chore(prlinter): added commit message validation #6573

Conversation

iliapolo commented Mar 3, 2020 • edited Loading

What we have know

What will change

Caveat

Commit Message

aws-cdk-automation commented Mar 3, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 3, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 3, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 4, 2020

AWS CodeBuild CI Report

iliapolo commented Mar 4, 2020

iliapolo commented Mar 8, 2020 • edited Loading

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

mergify bot commented Mar 8, 2020

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

aws-cdk-automation commented Mar 8, 2020

AWS CodeBuild CI Report

mergify bot commented Mar 8, 2020

iliapolo commented Mar 3, 2020 •

edited

Loading

iliapolo commented Mar 8, 2020 •

edited

Loading