Skip to content
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

Temp Fix for Windows CI #161

Merged
merged 6 commits into from
Mar 7, 2025
Merged

Conversation

t0mdavid-m
Copy link
Member

@t0mdavid-m t0mdavid-m commented Mar 7, 2025

Cdash on seqan is currently not working. This PR fixes this temporarily by applying the fix from the main repository (will only be included in the openms 3.4 release).

Summary by CodeRabbit

  • Chores
    • Enhanced the Windows executable build process by adding a new automation step to fetch the latest configuration files.
    • Improved workflow stability to ensure reliable build outputs while external dependencies undergo updates.

Copy link

coderabbitai bot commented Mar 7, 2025

Walkthrough

Two GitHub Actions workflows have been modified to include an additional step called "Get latest cibuild.cmake." In both workflows, after the initial checkout step, the action now configures the Git user settings, fetches the latest changes from the origin, and checks out specific files (cibuild.cmake, citest.cmake, and cipackage.cmake). This temporary measure is implemented to address issues related to the SeqAn library being offline or awaiting a new OpenMS (version 3.4) release. No changes were made to any public or exported entities.

Changes

File(s) Change Summary
.github/.../build-windows-executable-app.yaml
.github/.../build-windows-executable-app-with-pyinstaller.yaml
Added a new "Get latest cibuild.cmake" step after the checkout. The step sets up Git user configuration, fetches the latest changes, and checks out cibuild.cmake, citest.cmake, and cipackage.cmake for a temporary fix.

Sequence Diagram(s)

sequenceDiagram
    actor Runner as GitHub Runner
    participant Repo as Repository
    Runner->>Repo: Checkout code
    Runner->>Runner: Configure Git user (name & email)
    Runner->>Repo: Fetch latest changes
    Runner->>Repo: Checkout files (cibuild.cmake, citest.cmake, cipackage.cmake)
    Runner->>Runner: Proceed with build process
Loading

Poem

I’m the bunny of the build, hopping through each line,
Fetching files with care, making everything align.
My paws tap the keys, ensuring all is fine,
In a Git garden where changes brightly shine.
Hop along with me, for each fix is a sign! 🐇

Code-ruffling days made bright with each new design!


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
.github/workflows/build-windows-executable-app-with-pyinstaller.yaml (2)

21-29: Temporary Fix via Cherry-pick Commit
The newly added step cherry-picks commit ccb989e from the OpenMS repository as a temporary remedy for SeqAn-related issues until the upcoming 3.4 release. Consider enhancing the robustness of this step by adding error handling (for example, checking the exit status of the cherry-pick command) to gracefully manage any potential conflicts or failures.


30-30: Remove Trailing Whitespace
Static analysis detected trailing spaces on line 30. Please remove these to meet YAML formatting standards.

.github/workflows/build-windows-executable-app.yaml (2)

31-38: Temporary Cherry-pick Commit Step
The addition of the "Cherry-pick commit" step applies commit ccb989e from the OpenMS repository, serving as a temporary fix for the SeqAn downtime until OpenMS 3.4 is released. Similar to the other workflow, consider incorporating error handling to account for any failures during the cherry-pick process. Verify periodically that the commit is still valid in the targeted branch.


1-29: Inconsistent Checkout Versions
Notice that this workflow uses actions/checkout@v4, whereas the corresponding PyInstaller workflow uses actions/checkout@v3. Please confirm that this difference in checkout versions is intentional and won't lead to compatibility issues across workflows.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 8-8: trailing spaces

(trailing-spaces)


[error] 10-10: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d65c9c9 and e7ff3db.

📒 Files selected for processing (2)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml (1 hunks)
  • .github/workflows/build-windows-executable-app.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/build-windows-executable-app.yaml

[error] 30-30: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-simple-app
  • GitHub Check: build-full-app

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/build-windows-executable-app.yaml (2)

30-30: Remove trailing whitespace.
Line 30 contains trailing spaces, which violates YAMLlint standards and may lead to formatting inconsistencies. Please remove any extra trailing whitespace.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 30-30: trailing spaces

(trailing-spaces)


31-39: Implementing the temporary fix to fetch configuration files.
The newly added step correctly sets the Git configuration, fetches the latest changes from the develop branch, and checks out the files tools/ci/cibuild.cmake and tools/ci/citest.cmake. This temporary measure is appropriate given the current unavailability of SeqAn and the anticipation of the OpenMS 3.4 release.

Note: While hard-coding the branch name (develop) is acceptable for a short-term fix, please ensure that this step is revisited for stability in future releases. Additionally, consider adding error handling (if not already provided by GitHub Actions’ default behavior) to catch any issues during the file checkout process.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7ff3db and c13685d.

📒 Files selected for processing (2)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml (1 hunks)
  • .github/workflows/build-windows-executable-app.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/build-windows-executable-app.yaml

[error] 30-30: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-full-app
  • GitHub Check: build-simple-app

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/build-windows-executable-app.yaml (2)

30-30: Remove Trailing Whitespace.
YAMLlint detected trailing whitespace on this line. Please remove any extraneous spaces to ensure consistency with YAML style guidelines.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 30-30: trailing spaces

(trailing-spaces)


31-39: Temporary Fix Step for Configuration Files.
The newly added "Get latest cibuild.cmake" step correctly configures Git, fetches from the develop branch, and checks out the required configuration files. This serves as a practical temporary solution until OpenMS 3.4 is released and the SeqAn issue is resolved. Please ensure that this step is revisited and removed or refactored when the permanent fix is implemented.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c13685d and 75f027a.

📒 Files selected for processing (2)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml (1 hunks)
  • .github/workflows/build-windows-executable-app.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/build-windows-executable-app.yaml

[error] 30-30: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build-openms
  • GitHub Check: build-full-app
  • GitHub Check: build-simple-app

@t0mdavid-m
Copy link
Member Author

@jcharkow Any idea why the gui tests would be failing?

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/build-windows-executable-app.yaml (2)

30-30: Remove Trailing Spaces

Line 30 contains trailing spaces, as flagged by YAMLlint. Removing these extra whitespaces improves overall file cleanliness and avoids potential linting issues.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 30-30: trailing spaces

(trailing-spaces)


31-40: Temporary CI Configuration Update

This new step fetches and checks out updated CI configuration files (cibuild.cmake, citest.cmake, and cipackage.cmake) from the origin/develop branch. Since this is a temporary workaround until SeqAn is back online or a new OpenMS release (3.4) is available, please ensure to schedule its removal or proper revision in the future. As an enhancement, consider pinning the checkout to a specific commit or tag to avoid unexpected changes from the develop branch.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75f027a and 1c67d5f.

📒 Files selected for processing (2)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml (1 hunks)
  • .github/workflows/build-windows-executable-app.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/build-windows-executable-app-with-pyinstaller.yaml
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/build-windows-executable-app.yaml

[error] 30-30: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build-openms
  • GitHub Check: build-simple-app
  • GitHub Check: build-full-app

@t0mdavid-m
Copy link
Member Author

Looks like the GUI tests are failing intermittently because of a time out. I will open an issue for this.

@t0mdavid-m t0mdavid-m merged commit 85fc9c3 into OpenMS:main Mar 7, 2025
7 checks passed
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.

1 participant