Fix windows conda package upload and build ci #1792
Conversation
WalkthroughThe recent updates primarily focus on refining the CI/CD workflows and updating installation instructions. Changes to the GitHub Actions workflows involve adjusting operating system conditions and toggling steps for uploading packages. Additionally, the installation documentation has been updated to reflect the latest SLEAP version. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://github.com/avatars/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/build.yml (2 hunks)
- .github/workflows/build_manual.yml (5 hunks)
Additional comments not posted (6)
.github/workflows/build_manual.yml (4)
212-215: Logout step is crucial for security. Ensure it is correctly implemented.This logout step is essential for maintaining security by ensuring that session tokens are not left active after the workflow completes.
63-70: The pip wheel upload step for Ubuntu is commented out.
191-196: Ensure the correct path and label are used for uploading the Windows conda package.
173-180: Ensure the Anaconda login command syntax is correct and secure..github/workflows/build.yml (2)
167-167: Ensure the condition for the Anaconda login step is correctly targeting the updated Windows version.The update from
windows-2019towindows-2022is correctly reflected here, aligning with the PR's objectives to fix issues related to the Windows build environment.
185-190: Check the conditions for uploading the conda package to ensure they correctly differentiate between main and dev releases.
.github/workflows/build_manual.yml
Outdated
| # - fakebranch | ||
| - elizabeth/Fix-windows-build-and-build-CI |
There was a problem hiding this comment.
Branch name in the trigger paths seems to be specific to a user or feature branch.
Consider using more generic branch names or patterns (like feature/*) to avoid hardcoding specific user branches which might not be relevant in the future.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/build_ci.yml (1 hunks)
Files skipped from review due to trivial changes (1)
- .github/workflows/build_ci.yml
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/build_manual.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/build_manual.yml
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (6)
docs/installation.md (6)
Line range hint
3-3: Correct the naming of Apple's operating system.- Mac OS X, and Mac OS Apple Silicon + macOS, and macOS Apple SiliconThis change corrects the operating system name to "macOS," which is the official naming convention used by Apple.
Line range hint
43-43: Consider adding a comma for clarity.- your terminal should give you two extra commands to run listed under **Next Steps**. + your terminal should give you two extra commands to run, listed under **Next Steps**.Adding a comma after "run" improves the readability of the sentence.
Line range hint
183-183: Correct article usage before an acronym starting with a vowel sound.- If you do not have a NVIDIA GPU + If you do not have an NVIDIA GPUUsing "an" before "NVIDIA" is grammatically correct as "NVIDIA" starts with a vowel sound.
Line range hint
238-238: Correct the naming of Apple's operating system.- any OS except Apple silicon + any OS except Apple SiliconThis change corrects the capitalization of "Apple Silicon" to match the official naming convention.
Line range hint
410-410: Simplify language for clarity.- what SLEAP is able to detect on your system + what SLEAP can detect on your systemUsing "can" instead of "is able to" simplifies the sentence and improves readability.
Line range hint
416-416: Simplify language for clarity.- If you were not able to get SLEAP installed + If you were unable to get SLEAP installedUsing "unable" instead of "were not able to" simplifies the sentence and improves readability.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/installation.md (1 hunks)
Additional context used
LanguageTool
docs/installation.md
[grammar] ~3-~3: The operating system from Apple is written “macOS”
Context: ...ackage on Windows, Linux, Mac OS X, and Mac OS Apple Silicon. SLEAP requires many com...
[uncategorized] ~43-~43: Possible missing comma found.
Context: ...l should give you two extra commands to run listed under Next Steps. ````{n...
[misspelling] ~183-~183: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... -n sleap ``` If you do not have a NVIDIA GPU, then you should use the no ...
[grammar] ~238-~238: Did you mean the proper noun “Apple Silicon”?
Context: ...This works on **any OS except Apple silicon** and on **Google Colab**.{note...
[style] ~410-~410: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...nning the diagnostics to see what SLEAP is able to detect on your system: ```bash sleap-d...
[style] ~416-~416: Consider using “unable” to avoid wordiness.
Context: ...`bash sleap-diagnostic ``` If you were not able to get SLEAP installed, activate the ma...
Markdownlint
docs/installation.md
31-31: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
92-92: null
Bare URL used
295-295: Expected: fenced; Actual: indented
Code block style
314-314: Expected: fenced; Actual: indented
Code block style
333-333: Expected: fenced; Actual: indented
Code block style
Additional comments not posted (1)
docs/installation.md (1)
140-140: Update the installation commands to the latest version.The update from
sleap=1.3.3tosleap=1.4.1a1in the installation commands ensures users install the most recent version of SLEAP. This change aligns with the PR objectives to update the installation documentation.Also applies to: 146-146
Description
build_manual.ymlto upload the Windows conda package.windows-2019towindows-2022inbuild.ymlupload stages.build_ci.ymland tested the Build CI.Types of changes
Does this address any currently open issues?
build.ymlfor the conda upload step was incorrect. This release v1.4.1a1 built but did not upload the Windows conda package.build_ci.ymlso I am not sure why it even ran. It is running without errors again.Outside contributors checklist
Thank you for contributing to SLEAP!
❤️
Summary by CodeRabbit
Documentation
Chores
windows-2022.