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.

Sign up for GitHub

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

Jump to bottom

Shortened URL for the commit message guidelines no longer works and change of URL shortening service #41697

Open
VoltrexKeyva opened this issue Jan 25, 2022 · 7 comments
Open

Shortened URL for the commit message guidelines no longer works and change of URL shortening service #41697

VoltrexKeyva opened this issue Jan 25, 2022 · 7 comments
Labels
meta Issues and PRs related to the general management of the project.

Comments

@VoltrexKeyva
Copy link
Member

VoltrexKeyva commented Jan 25, 2022 •
edited

As of now, the shortened URL redirecting to our commit message guidelines (https://goo.gl/p2fr5Q) in our commit linter no longer works due to an incorrect path and the URL shortening service will no longer work in the future, Google is transitioning from the Google URL Shortener to Firebase Dynamic Links as stated here.

For a trusted and long lasting new shortened URLs, it is a good idea one for one of the TSC members to create a new shortened URL to redirect to our commit message guidelines and for other shortened URLs that I might've missed by taking these steps or using a different URL shortener.

That being said, it's better to involve the TSC, so @nodejs/tsc.
@VoltrexKeyva VoltrexKeyva changed the title Shortened URL for the commit message guidelines no longer works Shortened URL for the commit message guidelines no longer works and change of URL shortening service Jan 25, 2022
@mmarchini
Copy link
Contributor

@VoltrexMaster do you have any suggestions of a different url shortener?

@VoltrexKeyva
Copy link
Member Author

@VoltrexMaster do you have any suggestions of a different url shortener?

From my experience, Bitly and TinyURL provide a great URL shortener service, but there are others that might be preferred by other TSC members.

@RaisinTen
Copy link
Contributor

Is it necessary to keep the url in the linter title? The linter already enforces the rules it needs to and given that the link is not something people can click, I don't think it is used a lot.

I don't think we use a lot of shortened urls. The only other one I found is in

node/lib/util.js

Line 274 in ccb8aae

// `!reason` guard inspired by bluebird (Ref: https://goo.gl/t5IS6M).
which can be replaced with the complete url.

@targos targos added the meta Issues and PRs related to the general management of the project. label Jan 30, 2022
@richardlau
Copy link
Member

For something like the commit message guidelines (or other URLs whose content we maintain), we could create a subdomain under nodejs.org and redirect paths from there. e.g. something like https://contributing.nodejs.org/commit-messages? (Technically we could do it without a new subdomain, e.g. https://nodejs.org/commit-messages, but I think I'd like to avoid mixing where pages under https://nodejs.org originate from.)

@mmarchini
Copy link
Contributor

I like that idea. Maybe we could host a URL shortener or a GH page (rendering our docs on https://github.com/nodejs/node/tree/master/doc/contributing) to simplify management of the URLs (I like the GH page option because it's one less server to manage).

@richardlau richardlau mentioned this issue Feb 25, 2022
Merged
@richardlau
Copy link
Member

richardlau commented Feb 25, 2022 •
edited

Is it necessary to keep the url in the linter title? The linter already enforces the rules it needs to and given that the link is not something people can click, I don't think it is used a lot.

Having reread this issue, @RaisinTen raises a good point. We originally used the shortened URL when we were testing in Travis, which did allow for it to be clickable. Thinking it about it more, we only need to point people to the guidelines on failure in that workflow because if it passes there's nothing to be done.

I've opened nodejs/core-validate-commit#95 to print the full https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines URL at the end of the TAP output on failure. Since GitHub's "Details" links on PR check failures automatically expand to the failing section, this should put the URL directly above the Error: Process completed with exit code 123. line. I think GitHub will also automatically make the link clickable. We could then remove the shortened URL from the workflow name.

richardlau added a commit to nodejs/core-validate-commit that referenced this issue Mar 1, 2022
@richardlau
feat: point to guidelines on failure in TAP output (#95)
0e137d0 
If commit linting fails, include the URL to the commit message
guidelines in the TAP output.

Refs: nodejs/node#41697
@richardlau richardlau mentioned this issue Mar 1, 2022
Merged
@richardlau
Copy link
Member

#42168 will drop the shortened URL from the commit message linter workflow title.

If the only other example of a shortened URL is #41697 (comment) I'd suggest we update that with a full URL and not bother using/setting up an alternative URL shortening service.

nodejs-github-bot pushed a commit that referenced this issue Mar 3, 2022
@richardlau
build: drop shortened URL from lint-commit-message
2d6aea7 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: #42168
Refs: nodejs/core-validate-commit#95
Refs: #41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
sxa pushed a commit to sxa/node that referenced this issue Mar 7, 2022
@richardlau @sxa
build: drop shortened URL from lint-commit-message
0bbb447 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: nodejs#42168
Refs: nodejs/core-validate-commit#95
Refs: nodejs#41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
danielleadams pushed a commit to danielleadams/node that referenced this issue Apr 21, 2022
@richardlau @danielleadams
build: drop shortened URL from lint-commit-message
3391f2d 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: nodejs#42168
Refs: nodejs/core-validate-commit#95
Refs: nodejs#41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
danielleadams pushed a commit that referenced this issue Apr 24, 2022
@richardlau @danielleadams
build: drop shortened URL from lint-commit-message
2926f0b 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: #42168
Refs: nodejs/core-validate-commit#95
Refs: #41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
danielleadams pushed a commit that referenced this issue Apr 24, 2022
@richardlau @danielleadams
build: drop shortened URL from lint-commit-message
744e84e 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: #42168
Refs: nodejs/core-validate-commit#95
Refs: #41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
danielleadams pushed a commit that referenced this issue Apr 24, 2022
@richardlau @danielleadams
build: drop shortened URL from lint-commit-message
ba56e41 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: #42168
Refs: nodejs/core-validate-commit#95
Refs: #41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
xtx1130 pushed a commit to xtx1130/node that referenced this issue Apr 25, 2022
@richardlau @xtx1130
build: drop shortened URL from lint-commit-message
4d981fc 
The shortened link to the commit message guidelines no longer works
after they were moved from `docs/guides` to `docs/contributing`. Now
that `core-validate-commit` outputs an error message pointing to the
full URL of the commit message guidelines on failure we no longer need
to include the URL (shortened or otherwise) in the workflow title.

PR-URL: nodejs#42168
Refs: nodejs/core-validate-commit#95
Refs: nodejs#41697
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
meta Issues and PRs related to the general management of the project.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@targos @mmarchini @richardlau @RaisinTen @VoltrexKeyva