[Pulp-dev] Commit message validation

[David Davis]

In the two weeks since we’ve rolled out commit message issue validation,
there have been no complaints. Thus I’m rolling it out to pulp_file and
pulp_rpm next.

Also, QE brought to my attention a tool to validate the format of commit
messages called gitlint:

https://jorisroovers.github.io/gitlint/

It validates stuff like line length, trailing whitespace, etc. Interested
in people’s thoughts.

David


On Thu, Sep 13, 2018 at 1:07 PM David Davis <daviddavis at redhat.com> wrote:

> After some feedback, we’re changing the syntax of the keyword for no-issue
> commits. The original syntax (#noissue) was problematic because the # gets
> treated as a comment. The new syntax is going to be ‘[noissue]’.
>
> https://github.com/pulp/pulp/pull/3633
>
> David
>
>
> On Tue, Sep 11, 2018 at 10:15 AM David Davis <daviddavis at redhat.com>
> wrote:
>
>> I want to announce that commit messages will be validated for PRs against
>> pulp’s master branch per [0]. This validation will check two things.
>>
>> First, the validation script checks that there’s an attached issue in the
>> commit message. This is to prevent commits not being properly associated
>> with the issue they've fixed. If you absolutely must commit code without an
>> issue, add “#noissue” to the commit message.
>>
>> Second, issues in commits must be in a state of NEW/ASSIGNED/POST. This
>> is to prevent commits being associated against issues that have been closed
>> out and possibly released.
>>
>> Lastly, there’s a limitation in that multiple issues must be on separate
>> lines[1]. See [2] for an example.
>>
>> We plan to roll this out to more branches/repos so please submit any
>> feedback.
>>
>> [0] https://pulp.plan.io/issues/3930
>> [1] patches welcome!
>> [2]
>> https://github.com/pulp/pulp/pull/3614/files#diff-c2a1c5ead0bceb6cb9045af16e489f1eR77
>>
>> David
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20180927/939b5700/attachment.htm>