Skip to content

Include version number in release artifacts#1278

Open
alexdewar wants to merge 2 commits intomainfrom
include-version-number-in-release-artifacts
Open

Include version number in release artifacts#1278
alexdewar wants to merge 2 commits intomainfrom
include-version-number-in-release-artifacts

Conversation

@alexdewar
Copy link
Copy Markdown
Member

@alexdewar alexdewar commented May 8, 2026

Description

We currently call the release artifacts something like muse2_linux.tar.gz -- so we include the OS name, but not the version number. It's helpful to have the version number in there so you can see which version you have if you stumble across the file or want to download multiple different versions. This is common practice.

Update the release workflow accordingly. I'll also open a PR for the muse2_data_analysis repo as we'll need to update this CI action too (opened in draft here: EnergySystemsModellingLab/muse2_data_analysis#64).

Once this is merged I'll rename the files for the existing releases for consistency.

Closes #1232.

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 May 8, 2026 10:34
@codecov
Copy link
Copy Markdown

codecov Bot commented May 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.78%. Comparing base (ddf4a95) to head (3c0c574).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1278   +/-   ##
=======================================
  Coverage   89.78%   89.78%           
=======================================
  Files          57       57           
  Lines        8204     8204           
  Branches     8204     8204           
=======================================
  Hits         7366     7366           
  Misses        542      542           
  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

Updates the GitHub Actions release workflow so published release artifacts include the release version/tag in their filenames, making it easier to distinguish downloaded artifacts across versions.

Changes:

  • Append ${{ github.ref_name }} to archived release artifact filenames.
  • Update the softprops/action-gh-release upload configuration to match the new filenames.

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

run: |
cd muse2
${{ matrix.archive_cmd }} ../muse2_${{ matrix.osname }}.${{ matrix.archive_ext }} *
${{ matrix.archive_cmd }} ../muse2_${{ matrix.osname }}_${{ github.ref_name }}.${{ matrix.archive_ext }} *
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Ohh I totally didn't notice this! Looks like our .tar.gz files aren't actually compressed. I'll fix this for previous releases when I rename the files.

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.

Include version number in file names for release artifacts

3 participants