Fix broken link in v2.47.0 #1900
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As of v2.47.0, there is a problem where `/docs/platform-support` links to `/howto/maintain-git` (it should be prefixed with `/docs` is the bug). And indeed, directing a web browser to https://git-scm.com/docs/platform-support and following the "How to maintain Git" link will lead to a 404. This problem was identified correctly by https://github.com/git/git-scm.com/actions/runs/11219313103, but when that workflow run tried to open a ticket about the problem, it failed https://github.com/git/git-scm.com/actions/runs/11219313103/job/31184984303#step:11:127081 ReferenceError: req is not defined at eval (eval at callAsyncFunction (/home/runner/work/_actions/actions/github-script/v7/dist/index.js:35424:16), <anonymous>:33:42) at process.processTicksAndRejections (node:internal/process/task_queues:95:5) at async main (/home/runner/work/_actions/actions/github-script/v7/dist/index.js:35522:20) Error: Unhandled error: ReferenceError: req is not defined The problem is that the variable `req` was defined within too narrow a scope, which is fixed by this here commit. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Links should not "try to break outside" by starting with `../`. Let's detect that also when deploying in forks. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
In v2.47.0, the new `platform-support` document contains a link to a `.txt` file when it should point to a `.html` file instead. Let's add a work-around for that, to avoid a broken link. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Indentation here is done using spaces. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Updated via the `update-git-version-and-manual-pages.yml` GitHub workflow.
|
@jnavila could I solicit a review from you? |
Merged
ttaylorr
approved these changes
Oct 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This fixes:
docs/platform-supporttodocs/howto/maintain-git; by mistake it pointed to../howto/maintain-git)deploy-to-github-pagesAction that was supposed to open an issue when a broken link is detected, but instead errored out.Context
Git v2.47.0 was released today. But the workflow run that was supposed to update failed due to the combination of above-mentioned issues (broken links are not supposed to fail the
deployworkflow run specifically because those broken links are outside of git-scm.com's control).The commit 4593a42 was generated by a force-updating
update-git-version-and-manual-pagesrun.For the record, the broken link is not only worked around by one of the commits in this PR, but the underlying issue will (hopefully soon?) be fixed via gitgitgadget/git#1812.