Skip to content
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

Fix linkcheck #11940

Merged
merged 2 commits into from
Jul 5, 2023
Merged

Fix linkcheck #11940

merged 2 commits into from
Jul 5, 2023

Conversation

ru-fu
Copy link
Contributor

@ru-fu ru-fu commented Jul 5, 2023

No description provided.

ru-fu added 2 commits July 5, 2023 10:25
Signed-off-by: Ruth Fuchss <[email protected]>
Sometimes a failing linkcheck can be ignored, but we still want
to see that it is failing.
It's currently the last check, so all other checks will be run
before it fails. If we add checks after this one, they can be
added with condition "always()" to run even if the linkcheck
fails.

Signed-off-by: Ruth Fuchss <[email protected]>
@github-actions github-actions bot added the Documentation Documentation needs updating label Jul 5, 2023
@@ -296,7 +296,5 @@ jobs:
woke-args: "*.md **/*.md -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"

- name: Run link checker
# This can fail intermittently due to external resources being unavailable.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please can we keep this in so that if an external web site is down/unreachable it doesnt prevent the rest of the tests from running. I added this because we periodically get this job fail because the web site in question is down/unreachable.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the commit message - this is now the last of the test, so all other tests will run. If we add further tests, we can add them with "always()" so they still run.
If we don't fail this test, we will NEVER see if a link breaks, and we can just as well get rid of the test.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not show it as red/failed in the test results then?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the linkcheck will show as red - but that shouldn't prevent from merging?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK will merge this now and if we see it causing issues again in the future we can review then.

@tomponline tomponline merged commit 570f707 into canonical:main Jul 5, 2023
@ru-fu ru-fu deleted the fix-linkcheck branch July 5, 2023 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants