Skip to content

Fix broken link checker workflow#1147

Draft
alexdewar wants to merge 3 commits intomainfrom
fix-broken-links
Draft

Fix broken link checker workflow#1147
alexdewar wants to merge 3 commits intomainfrom
fix-broken-links

Conversation

@alexdewar
Copy link
Collaborator

@alexdewar alexdewar commented Feb 25, 2026

Description

The link checker workflow is currently not working, which is causing other open PRs to fail CI checks.

There are a few reasons:

  • A couple of broken links in docs/model/investment.md
  • We're getting really weird 404 errors for parts of the docs for the erased-serde crate that are linked to from our API docs, even though it should be generated automatically. Not sure what the problem is, but I've just ignored these for now.
  • A new weird error in the book/404.html file, which is also autogenerated, so I'm just ignoring the file now

The link checker workflow doesn't actually run on pushes to main. We are checking that the docs build ok, as part of the docs deployment workflow, but maybe we should also check links here too.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc
  • Update release notes for the latest release if this PR adds a new feature or fixes a bug
    present in the previous release

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

It seems the magic which converts `README.md` paths to `index.html` doesn't work here, because the generated path is to a non-existent `README.html`.
@alexdewar alexdewar force-pushed the fix-broken-links branch 2 times, most recently from 86743c2 to 4505241 Compare February 25, 2026 15:27
@codecov
Copy link

codecov bot commented Feb 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.52%. Comparing base (3d4b209) to head (237de2b).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1147   +/-   ##
=======================================
  Coverage   87.52%   87.52%           
=======================================
  Files          55       55           
  Lines        7626     7626           
  Branches     7626     7626           
=======================================
  Hits         6675     6675           
  Misses        649      649           
  Partials      302      302           

☔ 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.

@alexdewar alexdewar added this to MUSE Feb 25, 2026
@alexdewar alexdewar moved this to 👀 In review in MUSE Feb 25, 2026
\\( \sum_t act_t \\).

[overall MUSE2 workflow]: ./README.md#framework-overview
[framework-overview]: https://energysystemsmodellinglab.github.io/MUSE2/model/index.html#framework-overview
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we have to use a URL here rather than an internal link?

Copy link
Collaborator

@Aurashk Aurashk left a comment

Choose a reason for hiding this comment

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

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

3 participants