Skip to content

#3058 Update linkcheck parameters#3059

Merged
arporter merged 14 commits into
masterfrom
3058_fix_linkcheck
Jul 28, 2025
Merged

#3058 Update linkcheck parameters#3059
arporter merged 14 commits into
masterfrom
3058_fix_linkcheck

Conversation

@sergisiso

Copy link
Copy Markdown
Collaborator

No description provided.

@codecov

codecov Bot commented Jul 16, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.90%. Comparing base (6697b23) to head (73653a1).
⚠️ Report is 15 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3059   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files         368      368           
  Lines       51992    51992           
=======================================
  Hits        51942    51942           
  Misses         50       50           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sergisiso

sergisiso commented Jul 16, 2025

Copy link
Copy Markdown
Collaborator Author

The problem was that the default behaviour of the action is to filter unmodified lines of code. However this is not what we want as we link against generated pages, we could change what gets generated but keep the broken older link unchanged. We want to always check everything.

The action is now working properly, and example of a failed action can be seen here: https://github.com/stfc/PSyclone/actions/runs/16321579276/job/46100483733
(it will also produce inline annotations in the PR Files tab, but hopefully this are all gone when I put the PR for review)

@sergisiso sergisiso requested a review from hiker July 16, 2025 15:35
@sergisiso sergisiso self-assigned this Jul 16, 2025
@sergisiso

Copy link
Copy Markdown
Collaborator Author

I put this Ready for Review from @hiker even though the action still fails due to the broken links in lib/ READMEs, but I think @hiker may have been updating some of those, or at least changing the folder structure, so I need his advice to see if I should continue updating or wait for his changes to avoid conflicts.

@sergisiso

Copy link
Copy Markdown
Collaborator Author

@arporter @hiker @LonelyCat124 This is ready for review. It enables proper CI linkchecking in files outside the docs: examples, tutorials, READMEs, ... and fixes many currently broken links.

@arporter arporter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for fixing this Sergi and saving our blushes. Just a couple of minor things to fix and then this can go on.

Since it's all docstrings/documentation, I won't bother with the integration tests.

Comment thread lib/README.md
Comment thread lib/README.md Outdated
Comment thread tutorial/practicals/generic/1_intro_psyir/README.md
@sergisiso

Copy link
Copy Markdown
Collaborator Author

This is ready for another review @arporter

@arporter arporter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks very much Sergi, all good now.
Will proceed to merge.

@arporter arporter merged commit bb7bd3a into master Jul 28, 2025
13 of 14 checks passed
@arporter arporter deleted the 3058_fix_linkcheck branch July 28, 2025 20:11
arporter added a commit that referenced this pull request Jul 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants