-
Notifications
You must be signed in to change notification settings - Fork 73
Add option to skip removed URLs check #532
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
Open
jugmac00
wants to merge
1
commit into
canonical:main
Choose a base branch
from
jugmac00:make-url-checks-skippable
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| .. _skip-removed-urls-check: | ||
|
|
||
| Skip the removed URLs check | ||
| ============================ | ||
|
|
||
| The starter pack includes an automatic check that verifies no URLs are removed when you make changes to your documentation. | ||
| This helps prevent broken links when pages are removed without proper redirects. | ||
|
|
||
| However, in some cases you may want to intentionally skip this check, for example when: | ||
|
|
||
| * You are removing deprecated pages that are no longer relevant | ||
| * You are restructuring documentation and will add redirects in a follow-up commit | ||
| * You are working on a draft PR and will address URL changes later | ||
|
|
||
| How to skip the check | ||
| --------------------- | ||
|
|
||
| To skip the removed URLs check, include the text ``skip removed-urls-check`` in one of the following places: | ||
|
|
||
| * The pull request title | ||
| * The pull request body/description | ||
| * A commit message | ||
|
|
||
| Example commit | ||
| -------------- | ||
|
|
||
| Here's an example of a commit message that will skip the removed URLs check:: | ||
|
|
||
| Remove outdated installation guide | ||
|
|
||
| The old installation instructions are no longer relevant | ||
| after the new unified setup process was introduced. | ||
|
|
||
| skip removed-urls-check | ||
|
|
||
| When you push this commit and create a pull request, the removed URLs check workflow will be skipped automatically. | ||
|
|
||
| .. note:: | ||
| Use this feature responsibly. Removing URLs without proper redirects can lead to broken links and a poor user experience. | ||
| Make sure you have a valid reason to skip the check. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be better to just use the PR title and body, as this action only runs in a PR - and it will only read from the head commit to skip the action.