Skip to content

fix: Add quiet flag to linkchecker#536

Merged
nhennigan merged 2 commits into
mainfrom
docpr-2403-linkcheck-quiet
Feb 20, 2026
Merged

fix: Add quiet flag to linkchecker#536
nhennigan merged 2 commits into
mainfrom
docpr-2403-linkcheck-quiet

Conversation

@nhennigan

@nhennigan nhennigan commented Feb 19, 2026

Copy link
Copy Markdown
Contributor

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.

  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
    Can I get some guidance on how the changelog should look?
  • Have you updated the documentation for this change?
    The documentation on the linkchecker does not go into this level of detail and does not need to be updated

@medubelko

medubelko commented Feb 19, 2026

Copy link
Copy Markdown
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)

@nhennigan nhennigan force-pushed the docpr-2403-linkcheck-quiet branch from b84d002 to c94c77d Compare February 19, 2026 23:54
@nhennigan

Copy link
Copy Markdown
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 medubelko left a comment

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.

Comment thread CHANGELOG.md Outdated
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.
@nhennigan nhennigan force-pushed the docpr-2403-linkcheck-quiet branch from c94c77d to 0364365 Compare February 20, 2026 15:23
@jahn-junior jahn-junior self-requested a review February 20, 2026 15:54

@jahn-junior jahn-junior left a comment

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.

LGTM. Thanks!

@nhennigan nhennigan merged commit 8313250 into main Feb 20, 2026
9 checks passed
@nhennigan nhennigan deleted the docpr-2403-linkcheck-quiet branch February 20, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants