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.

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

Docs: Use HEAD rather than master for GitHub URIs #43993

Merged

Conversation

sarayourfriend
Copy link
Contributor

@sarayourfriend sarayourfriend commented Jul 8, 2020

Changes proposed in this Pull Request

  • Change all GitHub URIs that reference blob/master to use blob/HEAD which is a default, branch-name-agnostic alias for the "main" branch of a repository, regardless of what it is actually called.

Note: Sometimes this alias does not exist if you do some funky stuff but it is the neutral default when you create a new repository through GitHub's UI. When the alias does not exist, the only thing we can do is wait for the project to change their default branch name, if they ever do. I manually checked each repository we reference and didn't find anything other than truly dead links (to files that no longer exist).

Testing instructions

  • Ensure all changed links still work (you only need to test one link per repository as really it's just necessary to verify that the repo configuration includes HEAD -> master alias).

Part of #43395

@sarayourfriend sarayourfriend requested review from a team as code owners July 8, 2020 15:04
@matticbot
Copy link
Contributor

@sarayourfriend sarayourfriend mentioned this pull request Jul 8, 2020
21 tasks
@@ -7,6 +7,6 @@ Depending on the use case, this may be appropriate.

Further reading:

https://github.com/Modernizr/Modernizr/blob/master/feature-detects/touchevents.js
https://github.com/Modernizr/Modernizr/blob/HEAD/feature-detects/touchevents.js
Copy link
Contributor Author

@sarayourfriend sarayourfriend Jul 8, 2020

Choose a reason for hiding this comment

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

This link is fully broken even with blob/master. Looks like a casualty of a refactor. We should use perma links!

@@ -4,7 +4,7 @@
*
* @copyright Modernizr © 2009-2015.
* @license See CREDITS.md.
* @see https://github.com/Modernizr/Modernizr/blob/master/feature-detects/touchevents.js
* @see https://github.com/Modernizr/Modernizr/blob/HEAD/feature-detects/touchevents.js
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ditto

@matticbot
Copy link
Contributor

This PR does not affect the size of JS and CSS bundles shipped to the user's browser.

Generated by performance advisor bot at iscalypsofastyet.com.

@matticbot
Copy link
Contributor

Caution: This PR affects files in the FSE Plugin on WordPress.com
Please ensure your changes work on WordPress.com before merging.

D46104-code has been created so you can easily test it on your sandbox. See this FieldGuide page about developing in the FSE Plugin for more info: PCYsg-ly5-p2

@sarayourfriend sarayourfriend force-pushed the update/use-HEAD-rather-than-master-for-github-urls branch from 8fd816e to cd30ce3 Compare July 8, 2020 15:17
@sarayourfriend sarayourfriend requested review from oandregal and a team as code owners July 8, 2020 15:17
@sarayourfriend sarayourfriend changed the title Docs: Use blob/HEAD rather than blob/master for GitHub URIs Docs: Use HEAD rather than master for GitHub URIs Jul 8, 2020
@sarayourfriend sarayourfriend merged commit 0c08421 into master Jul 8, 2020
@sarayourfriend sarayourfriend deleted the update/use-HEAD-rather-than-master-for-github-urls branch July 8, 2020 17:19
@deBhal deBhal mentioned this pull request Jul 13, 2020
31 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants