Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/check-removed-urls.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ on:
jobs:
build-docs:
runs-on: ubuntu-latest
if: |
!contains(github.event.pull_request.title, 'skip check-removed-urls') &&
!contains(github.event.pull_request.body, 'skip check-removed-urls') &&
!contains(github.event.head_commit.message, 'skip check-removed-urls')
Copy link
Copy Markdown
Collaborator

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.

steps:
- name: Checkout PR branch
uses: actions/checkout@v5
Expand Down
1 change: 1 addition & 0 deletions docs/how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Set up, configure, upgrade, and customize your project to keep it organized and
migrate-from-pre-extension
update
troubleshoot-issues
skip-removed-urls-check

Optional features and workflows
-------------------------------
Expand Down
40 changes: 40 additions & 0 deletions docs/how-to/skip-removed-urls-check.rst
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.
Loading