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: update formula and cask URLs to new sharded format #15904

Merged
merged 1 commit into from Aug 26, 2023

Conversation

zgracem
Copy link
Contributor

@zgracem zgracem commented Aug 23, 2023

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • [N/A] Have you written new tests for your changes? Here's an example.
  • [N/A] Have you successfully run brew style with your changes locally?
  • [N/A] Have you successfully run brew typecheck with your changes locally?
  • [N/A] Have you successfully run brew tests with your changes locally?

I was reading through Homebrew's documentation yesterday and noticed that links into the source tree were broken because of the recent reorganization into alphabetized subdirectories. So I searched docs/*.md with the regex /homebrew-(cask|core)/blob/\w+/(Formula|Casks)/[^/]+?\.rb and:

  • Links to HEAD were changed to add the single-char subdirectory to the path. Easy peasy.
  • Links to specific lines of code at specific commits were updated in different ways:
    • If the code still existed in the same file, the URL was updated to its most recent commit (as of 22 August 2023) and the line numbers were updated if necessary.
    • If the file no longer contained relevant example code, or had been deleted, the link was updated to point to a similar file that does, at that new file's most recent commit (as of 22/8/23). If the link had an adjacent line or three of code in the doc itself, I updated that code from the new file... if I noticed it.
  • A handful of links were so old that the code they referenced has been deprecated and removed from Homebrew altogether; no current examples remain (or, presumably, are required). Those links I left unchanged, to be picked up in future substantive edits to the docs' content.

I hope this is a helpful addition to the work in #15891. Please let me know if you have any questions.

@zgracem zgracem mentioned this pull request Aug 23, 2023
7 tasks
@MikeMcQuaid MikeMcQuaid requested a review from Bo98 August 24, 2023 12:07
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looks good to me so far, nice work @zgracem!

docs/Cask-Cookbook.md Outdated Show resolved Hide resolved
Copy link
Member

@Bo98 Bo98 left a comment

Choose a reason for hiding this comment

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

Thanks!

docs/Cask-Cookbook.md Outdated Show resolved Hide resolved
@MikeMcQuaid MikeMcQuaid merged commit b69bd66 into Homebrew:master Aug 26, 2023
23 of 24 checks passed
@zgracem zgracem deleted the update-docs-urls branch August 28, 2023 20:09
@github-actions github-actions bot added the outdated PR was locked due to age label Sep 28, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants