Skip to content

Fix: Add missing links to v2.1.0 release notes#1231

Merged
alexdewar merged 1 commit intomainfrom
add-missing-links-to-release-notes
Mar 31, 2026
Merged

Fix: Add missing links to v2.1.0 release notes#1231
alexdewar merged 1 commit intomainfrom
add-missing-links-to-release-notes

Conversation

@alexdewar
Copy link
Copy Markdown
Collaborator

Description

I spotted a few places where there were links for issues/PRs without an entry at the bottom of the file.

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

Copilot AI review requested due to automatic review settings March 31, 2026 12:15
@alexdewar alexdewar added bug Something isn't working documentation Improvements or additions to documentation labels Mar 31, 2026
@alexdewar alexdewar requested a review from tsmbland March 31, 2026 12:15
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.74%. Comparing base (656eb32) to head (921f368).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1231   +/-   ##
=======================================
  Coverage   89.74%   89.74%           
=======================================
  Files          57       57           
  Lines        8195     8195           
  Branches     8195     8195           
=======================================
  Hits         7355     7355           
  Misses        544      544           
  Partials      296      296           

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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds missing PR link-reference definitions to the v2.1.0 release notes so all inline [#NNNN] references resolve correctly when rendered.

Changes:

  • Added link definitions for [#1110], [#1168], [#1170], and [#1205] in docs/release_notes/v2.1.0.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Collaborator

@tsmbland tsmbland left a comment

Choose a reason for hiding this comment

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

Oops! That's weird, I added most of these in d812a06 but seem to have accidentally deleted them in 99fcd86. Thanks for checking!

[#1030]: https://github.com/EnergySystemsModellingLab/MUSE2/pull/1030
[#1096]: https://github.com/EnergySystemsModellingLab/MUSE2/pull/1096
[#1110]: https://github.com/EnergySystemsModellingLab/MUSE2/pull/1110
[#1168]: https://github.com/EnergySystemsModellingLab/MUSE2/pull/1168
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.

#1168 is actually an issue rather than a PR, but that link will redirect so all good

@alexdewar
Copy link
Copy Markdown
Collaborator Author

Cool. Let's make this release!

@alexdewar alexdewar merged commit d8e7627 into main Mar 31, 2026
12 checks passed
@alexdewar alexdewar deleted the add-missing-links-to-release-notes branch March 31, 2026 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants