-
Notifications
You must be signed in to change notification settings - Fork 2
Upload binaries on release #616
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #616 +/- ##
==========================================
- Coverage 85.34% 85.31% -0.03%
==========================================
Files 38 38
Lines 3399 3399
Branches 3399 3399
==========================================
- Hits 2901 2900 -1
- Misses 305 306 +1
Partials 193 193 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bc06a3d to
36f63e8
Compare
cd0ab52 to
557a143
Compare
It seems we forgot to do this, but it's useful e.g. to run the test workflow manually.
592fb32 to
8d68d44
Compare
8d68d44 to
25998f5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a CI workflow to build and upload MUSE 2.0 executables on release while also enabling the workflows to be manually triggered. It also adds readme files for the various supported operating systems and updates other workflows to include a workflow_dispatch trigger.
- Adds a release workflow that builds, archives, and uploads release files.
- Introduces OS-specific readme files that describe usage and troubleshooting.
- Updates pre-commit, check-docs, and cargo-test workflows to support manual triggering.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| assets/readme/readme_windows.txt | New documentation file for Windows executable. |
| assets/readme/readme_macos_arm.txt | New documentation file for macOS (Apple Silicon) executable with troubleshooting details. |
| assets/readme/readme_linux.txt | New documentation file for Linux executable including dependency instructions. |
| assets/readme/README.md | Introduces a README that summarizes the readme files in the folder. |
| .github/workflows/release.yml | New CI workflow for release builds with OS-specific configurations and artifact uploads. |
| .github/workflows/pre-commit.yml | Added workflow_dispatch trigger for flexible CI triggering. |
| .github/workflows/check-docs.yml | Added workflow_dispatch trigger to enable manual docs checks. |
| .github/workflows/cargo-test.yml | Added workflow_dispatch trigger; note removal of an env block was observed. |
Description
This PR adds a CI workflow to build and upload executable files on release. The executables are stored in an archive with a readme file and a copy of the licence. Maybe we'll want a changelog in there too at some point.
In theory the program should run without any extra dependencies being installed.
I've also set the workflow to run when we push to
main. I know that's a little odd, but I'd like to check that things are still building as we go along, as they could stop working when we update dependencies etc. (e.g. the old version ofg++we're using might not be compatible with a newer version of HiGHS). In this case, the executables are uploaded as test artifacts.Unrelated change: I noticed we were missing the
workflow_dispatchtrigger for most of our workflows, so I've added it.Closes #128.
Type of change
Key checklist
$ cargo test$ cargo docFurther checks