Sync Sphinx stack - #10
Open
danieltoader-canonical wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Synchronizes parts of the Sphinx/docs maintenance stack by updating developer tooling and CI workflows, including extracting the “removed URLs” logic into a dedicated script.
Changes:
- Added a standalone
check_removed_urls.pyhelper script and updated the workflow to call it (instead of inline Python). - Updated the removed-URLs workflow checkout logic (now PR-context driven).
- Tightened GitHub Actions permissions for the CLA check workflow.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/_dev/update_sp.py | Updates the developer-facing invocation example path. |
| docs/_dev/check_removed_urls.py | Adds a reusable script to detect removed URLs missing redirects. |
| .github/workflows/cla-check.yml | Adds explicit GITHUB_TOKEN permissions for the CLA workflow. |
| .github/workflows/check-removed-urls.yml | Removes workflow_call inputs and switches URL comparison to the new script. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
3
to
6
| on: | ||
| workflow_call: | ||
| inputs: | ||
| base_ref: | ||
| required: false | ||
| type: string | ||
| base_repo: | ||
| required: false | ||
| type: string | ||
| pull_request: | ||
| branches: [main] |
| @@ -0,0 +1,98 @@ | |||
| #! /usr/bin/env python | |||
| # | ||
| # For debugging, please run this script with DEBUGGING=1 | ||
| # e.g. user@device:~/git/Canonical/sphinx-stack/docs$ DEBUGGING=1 python .sphinx/update_sp.py | ||
| # e.g. user@device:~/git/Canonical/sphinx-stack/docs$ DEBUGGING=1 python _dev/update_sp.py |
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
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.
CHANGELOG.mdwith relevant non-documentation file changes?