Skip to content

gitlint: allow commit messages to contain long footnotes #150

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

Merged

Conversation

phlogistonjohn
Copy link
Collaborator

@phlogistonjohn phlogistonjohn commented Jul 21, 2023

Configure gitlint to ignore lines that start like [1]: or [2] such that we can have long text like URLs in the commits without triggering other gitlint body rules.

PR contains two test commits to demonstrate the change that must be removed prior to merging.

spuiuk
spuiuk previously approved these changes Jul 21, 2023
Copy link
Collaborator

@spuiuk spuiuk left a comment

Choose a reason for hiding this comment

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

ACK - I am all for bending the rules for better readability.

Copy link
Collaborator

@obnoxxx obnoxxx left a comment

Choose a reason for hiding this comment

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

lgtm. But I think the two "deleteme" commits should be removed before merging

@mergify mergify bot dismissed spuiuk’s stale review July 24, 2023 14:36

Pull request has been modified.

Ignore lines that start like `[1]: ` or `[2]: ` such that we can have
long text like URLs in the commits without triggering other gitlint body
rules.

Signed-off-by: John Mulligan <[email protected]>
@phlogistonjohn phlogistonjohn marked this pull request as ready for review July 24, 2023 14:38
@phlogistonjohn
Copy link
Collaborator Author

phlogistonjohn commented Jul 24, 2023

This PR also enables the extremely useful feature of being able to put ascsii art in the message without tickling gitlint. Just prefix each line with [0] or something and go to town, like so:

stuff: useful things

This is an important commit message.

[0]  ___________________
[0] < this commit rocks >
[0]  ------------------- 
[0]    \
[0]     \
[0]         .--.
[0]        |o_o |
[0]        |:_/ |
[0]       //   \ \
[0]      (|     | )
[0]     /'\_   _/`\
[0]     \___)=(___/
[0]    
[0]                           PS. Please don't actually do this [1].
[0]
[0]
[1]                                      Unless your ascii art is actually a diagram or something

Copy link
Collaborator

@anoopcs9 anoopcs9 left a comment

Choose a reason for hiding this comment

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

lgtm.

Copy link
Collaborator

@spuiuk spuiuk left a comment

Choose a reason for hiding this comment

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

ACK

Copy link
Collaborator

@obnoxxx obnoxxx left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mergify mergify bot merged commit 54f1dad into samba-in-kubernetes:master Jul 25, 2023
@phlogistonjohn phlogistonjohn deleted the jjm-commit-footnotes branch July 25, 2023 13:22
phlogistonjohn added a commit to phlogistonjohn/samba-operator that referenced this pull request Jul 25, 2023
Ignore lines that start like `[1]: ` or `[2] ` such that we can have
long text like URLs in the commits without triggering other gitlint body
rules.

Copied from the same changes already made in samba-container
(PR samba-in-kubernetes/samba-container#150).

Signed-off-by: John Mulligan <[email protected]>
phlogistonjohn added a commit to phlogistonjohn/sambacc that referenced this pull request Jul 25, 2023
Ignore lines that start like `[1]: ` or `[2] ` such that we can have
long text like URLs in the commits without triggering other gitlint body
rules.

Copied from the same changes already made in samba-container
(PR samba-in-kubernetes/samba-container#150).

Signed-off-by: John Mulligan <[email protected]>
mergify bot pushed a commit to samba-in-kubernetes/samba-operator that referenced this pull request Jul 25, 2023
Ignore lines that start like `[1]: ` or `[2] ` such that we can have
long text like URLs in the commits without triggering other gitlint body
rules.

Copied from the same changes already made in samba-container
(PR samba-in-kubernetes/samba-container#150).

Signed-off-by: John Mulligan <[email protected]>
mergify bot pushed a commit to samba-in-kubernetes/sambacc that referenced this pull request Jul 25, 2023
Ignore lines that start like `[1]: ` or `[2] ` such that we can have
long text like URLs in the commits without triggering other gitlint body
rules.

Copied from the same changes already made in samba-container
(PR samba-in-kubernetes/samba-container#150).

Signed-off-by: John Mulligan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants