Allow long URLs in commit messages

[johnboyes]

I propose that URLs should always be allowed in the body of commit messages, even when longer than 72 characters.

Given that commit messages should be well-documented, relevant URLs should be encouraged, I'd say. Alternatives such as using a URL shortener have downsides (makes the writing of the commit message more cumbersome, and makes the actual destination URL opaque).

There seems to be something of a consensus in the open source world around allowing long URLs (1, 2, 3, 4).

If you agree and decide to add this feature, I'd propose as a potential implementation skipping the line length check for any line that has a URL in it. I think a check that only allows long URLs if they are the only content on a given line would be too restrictive, as a common approach is to have the urls sequentially numbered as reference links at the foot of the commit message.

[mristin]

Thanks for the suggestion! Let me also check what markdown proposes.

Give me a couple of days as it's a busy summer time at the moment.

[johnboyes]

Thanks, @mristin, no rush at all :-)

Here's another couple of links regarding markdown and this topic, FYI:

• https://www.markdownguide.org/basic-syntax/#reference-style-links
• https://daringfireball.net/projects/markdown/syntax#link
• http://www.rubycoloredglasses.com/2017/11/markdown-links-80-character-line-length/
• Ignore line length containing urls markdownlint/markdownlint#128
• https://stackoverflow.com/a/27071588

[johnboyes]

Have been thinking about this a little more. Given that this GitHub Action is opinionated (which is a great thing), one option would be to allow (and encourage) reference links, but not inline links, thoughts?

Personally I think that could be a very nice approach, as reference links are much more elegant than inline links when reading commit messages IMHO, and it would enforce one clear consistent way of specifying links.

Would also make sense to allow lines which just have a url and nothing else (i.e. the url is not a reference or inline link but rather is just shown in the message as a url)

Just sharing my thoughts :-)

[mristin]

Hi @johnboyes ,
I finally implemented both versions as people probably use variety of URL styles and both are acceptable. For example, in-line links can still be readable:

[See this page](
http://some-domain.com/long/long/long/long/path.html
).

and sometimes reading the URL helps the understanding (e.g., StackOverflow questions). If referenced, the reader looses the extra information up to the point that s/he reads the URL in the link definition.

I released a new patch version including this feature (2.1.1, https://github.com/mristin/opinionated-commit-message/releases/tag/v2.1.1).

Thanks again for the suggestion!

[johnboyes]

Thanks v much for implementing this so quickly, @mristin 😎

I've just given it a quick test and I'm still getting the long line error after upgrading to v2.1.1 - v grateful if you can take a look pls?

Here is the commit message which is failing:

Ensure long urls in commit messages are allowed

Please see [this page for more details][1] or read the manual.

[1]: http://some-domain.com/very/long/long/long/long/long/long/long/long/long/path.html

[mristin]

Hi @johnboyes ,
This is a strange bug -- I explicitly test for that case. I'll try to have a look at it during the next week.

[mristin]

Hi @johnboyes ,
It seems I simply forgot to include dist folder in the commit. Could you please check if the new patch version (2.1.2) works for you?

[johnboyes]

Just tested again and works perfectly now, thanks @mristin 👍