-
Notifications
You must be signed in to change notification settings - Fork 0
add muse2 main branch install to ci #50
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
Open
Aurashk
wants to merge
3
commits into
main
Choose a base branch
from
add-muse2-main-to-ci
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Setup MUSE2 from main | ||
| description: Build and configure MUSE2_PATH from the MUSE2 main branch via cargo install | ||
| inputs: | ||
| muse2_exe: | ||
| description: MUSE2 executable name for the current OS | ||
| required: true | ||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Install Rust toolchain | ||
| uses: actions-rust-lang/setup-rust-toolchain@v1 | ||
|
|
||
| - name: Build and install MUSE2 from main (cargo) | ||
| shell: bash | ||
| run: | | ||
| cargo install \ | ||
| --git https://github.com/EnergySystemsModellingLab/MUSE2 \ | ||
| --branch main \ | ||
| --root "$GITHUB_WORKSPACE/muse2_cargo_root" | ||
|
|
||
| - name: Set MUSE2_PATH (Linux / macOS) | ||
| if: runner.os == 'Linux' || runner.os == 'macOS' | ||
| shell: bash | ||
| run: | | ||
| echo "MUSE2_PATH=${{ github.workspace }}/muse2_cargo_root/bin/${{ inputs.muse2_exe }}" >> "$GITHUB_ENV" | ||
|
|
||
| - name: Set MUSE2_PATH (Windows) | ||
| if: runner.os == 'Windows' | ||
| shell: pwsh | ||
| run: | | ||
| $exePath = "${{ github.workspace }}\muse2_cargo_root\bin\${{ inputs.muse2_exe }}" | ||
| echo "MUSE2_PATH=$exePath" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| name: Setup MUSE2 from latest release | ||
| description: Download latest MUSE2 release asset for current OS and configure MUSE2_PATH | ||
| inputs: | ||
| github_token: | ||
| description: GitHub token for API access | ||
| required: true | ||
| muse2_exe: | ||
| description: MUSE2 executable name for the current OS | ||
| required: true | ||
| runs: | ||
| using: composite | ||
| steps: | ||
| - name: Get latest MUSE2 release tag | ||
| id: muse2_release | ||
| shell: bash | ||
| run: | | ||
| TAG=$(curl -sSf \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "Authorization: Bearer ${{ inputs.github_token }}" \ | ||
| https://api.github.com/repos/EnergySystemsModellingLab/MUSE2/releases/latest \ | ||
| | jq -r '.tag_name') | ||
|
|
||
| if [[ -z "$TAG" || "$TAG" == "null" ]]; then | ||
| echo "::error::Failed to retrieve latest MUSE2 release tag." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Resolved latest MUSE2 release: $TAG" | ||
| echo "tag=$TAG" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Download MUSE2 release asset | ||
| shell: bash | ||
| run: | | ||
| curl -sSfL \ | ||
| "https://github.com/EnergySystemsModellingLab/MUSE2/releases/download/${{ steps.muse2_release.outputs.tag }}/${{ runner.os == 'Windows' && 'muse2_windows.zip' || runner.os == 'macOS' && 'muse2_macos_arm.tar.gz' || 'muse2_linux.tar.gz' }}" \ | ||
| --output "muse2_asset_download" | ||
|
|
||
| - name: Extract and set MUSE2_PATH (Linux / macOS) | ||
| if: runner.os == 'Linux' || runner.os == 'macOS' | ||
| shell: bash | ||
| run: | | ||
| mkdir -p muse2_bin | ||
| tar -xf muse2_asset_download -C muse2_bin | ||
| chmod +x "muse2_bin/${{ inputs.muse2_exe }}" | ||
| echo "MUSE2_PATH=${{ github.workspace }}/muse2_bin/${{ inputs.muse2_exe }}" >> "$GITHUB_ENV" | ||
|
|
||
| - name: Extract and set MUSE2_PATH (Windows) | ||
| if: runner.os == 'Windows' | ||
| shell: pwsh | ||
| run: | | ||
| New-Item -ItemType Directory -Force -Path muse2_bin | Out-Null | ||
| Rename-Item -Path "muse2_asset_download" -NewName "muse2_asset_download.zip" | ||
| Expand-Archive -Path "muse2_asset_download.zip" -DestinationPath muse2_bin -Force | ||
| $exePath = "${{ github.workspace }}\muse2_bin\${{ inputs.muse2_exe }}" | ||
| echo "MUSE2_PATH=$exePath" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,24 @@ | ||||||||||
| name: Verify MUSE2 installation | ||||||||||
| description: Validate that MUSE2_PATH points to an executable file for the current OS | ||||||||||
| runs: | ||||||||||
| using: composite | ||||||||||
| steps: | ||||||||||
| - name: Verify MUSE2_PATH (Linux / macOS) | ||||||||||
| if: runner.os == 'Linux' || runner.os == 'macOS' | ||||||||||
| shell: bash | ||||||||||
| run: | | ||||||||||
| if [[ ! -f "$MUSE2_PATH" ]]; then | ||||||||||
| echo "::error::MUSE2 executable not found at: $MUSE2_PATH" | ||||||||||
|
Comment on lines
+10
to
+11
|
||||||||||
| if [[ ! -f "$MUSE2_PATH" ]]; then | |
| echo "::error::MUSE2 executable not found at: $MUSE2_PATH" | |
| if [[ ! -f "$MUSE2_PATH" || ! -x "$MUSE2_PATH" ]]; then | |
| echo "::error::MUSE2 executable not found or is not executable at: $MUSE2_PATH" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: Test and build | ||
| name: Test against MUSE2 | ||
| on: | ||
| push: | ||
| branches: [main] | ||
|
|
@@ -7,114 +7,16 @@ on: | |
| workflow_call: | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - os: ubuntu-latest | ||
| python-version: '3.14' | ||
| muse2_asset: muse2_linux.tar.gz | ||
| muse2_exe: muse2 | ||
| - os: windows-latest | ||
| python-version: '3.14' | ||
| muse2_asset: muse2_windows.zip | ||
| muse2_exe: muse2.exe | ||
| - os: macos-latest | ||
| python-version: '3.14' | ||
| muse2_asset: muse2_macos_arm.tar.gz | ||
| muse2_exe: muse2 | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v6 | ||
|
|
||
| - uses: astral-sh/setup-uv@v7 | ||
| with: | ||
| enable-cache: true | ||
| prune-cache: false | ||
| activate-environment: true | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| - name: Install dependencies | ||
| run: uv sync | ||
|
|
||
| # Query the GitHub API for the latest MUSE2 release tag (e.g. "v2.0.0"). | ||
| # The tag is written to GITHUB_OUTPUT so subsequent steps can reference it. | ||
| - name: Get latest MUSE2 release tag | ||
| id: muse2_release | ||
| shell: bash | ||
| run: | | ||
| TAG=$(curl -sSf \ | ||
| -H "Accept: application/vnd.github+json" \ | ||
| -H "Authorization: Bearer ${{ github.token }}" \ | ||
| https://api.github.com/repos/EnergySystemsModellingLab/MUSE2/releases/latest \ | ||
| | jq -r '.tag_name') | ||
|
|
||
| if [[ -z "$TAG" || "$TAG" == "null" ]]; then | ||
| echo "::error::Failed to retrieve latest MUSE2 release tag." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Resolved latest MUSE2 release: $TAG" | ||
| echo "tag=$TAG" >> "$GITHUB_OUTPUT" | ||
|
|
||
| # Download the platform-appropriate MUSE2 release asset. | ||
| # 'shell: bash' is used on all platforms | ||
| - name: Download MUSE2 release asset | ||
| shell: bash | ||
| run: | | ||
| curl -sSfL \ | ||
| "https://github.com/EnergySystemsModellingLab/MUSE2/releases/download/${{ steps.muse2_release.outputs.tag }}/${{ matrix.muse2_asset }}" \ | ||
| --output "muse2_asset_download" | ||
|
|
||
| - name: Extract MUSE2 and set environment variable (Linux / macOS) | ||
| if: runner.os == 'Linux' || runner.os == 'macOS' | ||
| shell: bash | ||
| run: | | ||
| mkdir -p muse2_bin | ||
| tar -xf muse2_asset_download -C muse2_bin | ||
| chmod +x "muse2_bin/${{ matrix.muse2_exe }}" | ||
| echo "MUSE2_PATH=${{ github.workspace }}/muse2_bin/${{ matrix.muse2_exe }}" >> "$GITHUB_ENV" | ||
|
|
||
| - name: Extract MUSE2 and set environment variable (Windows) | ||
| if: runner.os == 'Windows' | ||
| shell: pwsh | ||
| run: | | ||
| New-Item -ItemType Directory -Force -Path muse2_bin | Out-Null | ||
| Rename-Item -Path "muse2_asset_download" -NewName "muse2_asset_download.zip" | ||
| Expand-Archive -Path "muse2_asset_download.zip" -DestinationPath muse2_bin -Force | ||
| $exePath = "${{ github.workspace }}\muse2_bin\${{ matrix.muse2_exe }}" | ||
| echo "MUSE2_PATH=$exePath" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append | ||
|
|
||
| # Confirm the muse2 executable is present and the environment variable is set correctly. | ||
| - name: Verify MUSE2 installation (Linux / macOS) | ||
| if: runner.os == 'Linux' || runner.os == 'macOS' | ||
| shell: bash | ||
| run: | | ||
| if [[ ! -f "$MUSE2_PATH" ]]; then | ||
| echo "::error::MUSE2 executable not found at: $MUSE2_PATH" | ||
| exit 1 | ||
| fi | ||
| echo "MUSE2_PATH is set to: $MUSE2_PATH" | ||
|
|
||
| - name: Verify MUSE2 installation (Windows) | ||
| if: runner.os == 'Windows' | ||
| shell: pwsh | ||
| run: | | ||
| if (-not (Test-Path -Path $env:MUSE2_PATH -PathType Leaf)) { | ||
| Write-Error "MUSE2 executable not found at: $env:MUSE2_PATH" | ||
| exit 1 | ||
| } | ||
| Write-Host "MUSE2_PATH is set to: $env:MUSE2_PATH" | ||
|
|
||
| - name: Run tests | ||
| run: pytest | ||
|
|
||
| - name: Upload coverage to Codecov | ||
| if: runner.os == 'Linux' | ||
| uses: codecov/codecov-action@v5 | ||
| with: | ||
| token: ${{ secrets.CODECOV_TOKEN }} | ||
| files: ./coverage.xml | ||
| fail_ci_if_error: true | ||
| test_release: | ||
| name: Latest MUSE2 release | ||
| uses: ./.github/workflows/test-with-muse2.yml | ||
| with: | ||
| muse2_source: release | ||
| secrets: inherit | ||
|
|
||
| test_main: | ||
| name: Current MUSE2 main branch | ||
| uses: ./.github/workflows/test-with-muse2.yml | ||
| with: | ||
| muse2_source: main | ||
| secrets: inherit | ||
|
Comment on lines
+17
to
+22
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,71 @@ | ||||||
| name: Test with MUSE2 | ||||||
|
|
||||||
| on: | ||||||
| workflow_call: | ||||||
| inputs: | ||||||
| muse2_source: | ||||||
| description: Which MUSE2 source to test against (release or main) | ||||||
| required: true | ||||||
| type: string | ||||||
| secrets: | ||||||
| CODECOV_TOKEN: | ||||||
| required: false | ||||||
|
|
||||||
| jobs: | ||||||
| test: | ||||||
| name: Run Pytest | ||||||
| runs-on: ${{ matrix.os }} | ||||||
| strategy: | ||||||
| fail-fast: false | ||||||
| matrix: | ||||||
| include: | ||||||
| - os: ubuntu-latest | ||||||
| python-version: '3.14' | ||||||
| muse2_exe: muse2 | ||||||
| - os: windows-latest | ||||||
| python-version: '3.14' | ||||||
| muse2_exe: muse2.exe | ||||||
| - os: macos-latest | ||||||
| python-version: '3.14' | ||||||
| muse2_exe: muse2 | ||||||
|
|
||||||
| steps: | ||||||
| - uses: actions/checkout@v6 | ||||||
|
|
||||||
| - uses: astral-sh/setup-uv@v7 | ||||||
| with: | ||||||
| enable-cache: true | ||||||
| prune-cache: false | ||||||
| activate-environment: true | ||||||
| python-version: ${{ matrix.python-version }} | ||||||
|
|
||||||
| - name: Install dependencies | ||||||
| run: uv sync | ||||||
|
|
||||||
| - name: Setup MUSE2 from main | ||||||
| if: inputs.muse2_source == 'main' | ||||||
| uses: ./.github/actions/setup-muse2-main | ||||||
| with: | ||||||
| muse2_exe: ${{ matrix.muse2_exe }} | ||||||
|
Comment on lines
+45
to
+49
|
||||||
|
|
||||||
| - name: Setup MUSE2 from latest release | ||||||
| if: inputs.muse2_source == 'release' | ||||||
| uses: ./.github/actions/setup-muse2-release | ||||||
| with: | ||||||
| github_token: ${{ github.token }} | ||||||
| muse2_exe: ${{ matrix.muse2_exe }} | ||||||
|
|
||||||
| - name: Verify MUSE2 installation | ||||||
| uses: ./.github/actions/verify-muse2 | ||||||
|
|
||||||
| - name: Run tests | ||||||
| run: pytest | ||||||
|
|
||||||
| - name: Upload coverage to Codecov | ||||||
| # Latest linux release only - they should all be the same | ||||||
| if: runner.os == 'Linux' && inputs.muse2_source == 'release' | ||||||
|
||||||
| if: runner.os == 'Linux' && inputs.muse2_source == 'release' | |
| if: runner.os == 'Linux' && inputs.muse2_source == 'release' && secrets.CODECOV_TOKEN != '' |
Comment on lines
+64
to
+71
Copilot
AI
Apr 24, 2026
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.
CODECOV_TOKEN is declared as an optional secret for this reusable workflow, but the Codecov step will still run (on Linux release) and passes token: ${{ secrets.CODECOV_TOKEN }} with fail_ci_if_error: true. In contexts where secrets aren’t available (e.g., PRs from forks) or the caller doesn’t provide the token, this can cause the workflow to fail unexpectedly. Consider updating the if: guard to also require a non-empty token (or skip uploads on forked PRs), or make the token required if failures are desired.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The action description says it validates that
MUSE2_PATHpoints to an executable, but the checks only assert the path is an existing file (Linux/macOS:-f; Windows:Test-Path -PathType Leaf). Either update the checks to verify executability (e.g.,-xon Linux/macOS) or adjust the description to match what is actually validated.