fix: Add quiet flag to linkchecker#536
Merged
Merged
Conversation
Collaborator
|
@nhennigan The workflow for adding to the changelog is a bit odd. It's self-referential. After creation of the PR, go back to your branch and add another commit that modifies the changelog and includes a link to the PR itself. Since there's no changelog entry for the next version yet, here's what I'd add to the start of the log: ## Upcoming
* <brief description>
### Changed
* `docs/Makefile` [#536](https://github.com/canonical/sphinx-docs-starter-pack/pull/536) |
b84d002 to
c94c77d
Compare
Contributor
Author
|
Thanks @medubelko I was unsure of what title to add as I am not creating a release based solely on this fix. I have added it now and rebased to main so I get the broken links fixes. |
medubelko
approved these changes
Feb 20, 2026
jahn-junior
reviewed
Feb 20, 2026
rkratky
approved these changes
Feb 20, 2026
It was reported in an issue that the verbose output of all the OK links in the make linkchecker command made it difficult to see actual errors. Adding the -q flag to the linkcheck command will mean only errors and broken links will be printed. This will be picked up by the workflows too as they use the Makefile in the repo they are running on to decide what parameters to feed the linkchecker.
c94c77d to
0364365
Compare
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.
It was reported in canonical/documentation-workflows#37 issue that the verbose output of all the OK links in the make linkchecker command made it difficult to see actual errors. Adding the -q flag to the linkcheck command will mean only errors and broken links will be printed.
This will be picked up by the workflows too as they use the Makefile in the repo they are running on to decide what parameters to feed the linkchecker.
CHANGELOG.mdwith relevant non-documentation file changes?Can I get some guidance on how the changelog should look?
The documentation on the linkchecker does not go into this level of detail and does not need to be updated