Skip to content

Conversation

@fgvieira
Copy link
Contributor

@fgvieira fgvieira commented Oct 20, 2025

Some small fixes I noticed when deploying snakemake-scheduler-plugin-firstfit:

  • run build in dev env
  • install build instead of python-build
  • add token to release-please

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 20, 2025

📝 Walkthrough

Walkthrough

This PR updates development dependencies and GitHub Actions workflow configuration. It replaces the "python-build" package with "build" in Pixi dev tasks and adds token authentication and environment flag modifications to the release-please workflow.

Changes

Cohort / File(s) Summary
Pixi dev dependency update
snakedeploy/scaffold_plugins/common.py
Replaced "python-build" with "build" in the dev dependency list for Pixi tasks
Release workflow configuration
snakedeploy/templates/plugins/release_please.yml.j2
Added secrets.RELEASE_PLEASE_PR_CI_TOKEN token parameter to the release-please GitHub Actions step; Updated build step to execute pixi run -e dev check-build instead of pixi run check-build

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • johanneskoester

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The PR title "fix: scheduler template" does not accurately reflect the actual changes in the pull request. The modifications involve updating dev dependencies (replacing "python-build" with "build") in common.py and enhancing the release-please workflow template by adding token parameters and updating the pixi build step with the -e dev flag. There is no scheduler-related code present in the changeset, making the title misleading or off-topic. Consider renaming the PR title to more accurately reflect the actual changes, such as "fix: update release-please template with token and pixi flags" or "fix: add token parameter and pixi dev flag to release workflow". This would help reviewers quickly understand the primary purpose of the changeset.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d98dffd and 6a219cc.

📒 Files selected for processing (2)
  • snakedeploy/scaffold_plugins/common.py (1 hunks)
  • snakedeploy/templates/plugins/release_please.yml.j2 (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.py

⚙️ CodeRabbit configuration file

**/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

Files:

  • snakedeploy/scaffold_plugins/common.py
🔇 Additional comments (3)
snakedeploy/scaffold_plugins/common.py (1)

85-85: Correct package name for PyPI installation.

The change from "python-build" to "build" is correct. The PyPI package name is "build", while "python-build" is only used on conda-forge. This fix ensures the correct package is installed when using pixi add --pypi, which is required for the python -m build command at line 120.

Based on learnings.

snakedeploy/templates/plugins/release_please.yml.j2 (2)

22-22: Verify custom token configuration and document its purpose.

The custom token RELEASE_PLEASE_PR_CI_TOKEN is being used instead of the default GITHUB_TOKEN. This typically indicates a need for elevated permissions (e.g., triggering subsequent workflows). Ensure that:

  1. The secret is properly configured in the repository settings
  2. The token has appropriate scoped permissions
  3. The reason for using a custom token is documented (README or workflow comments)

Can you confirm the token is configured and consider adding a comment in the workflow explaining why the custom token is needed?


40-40: Correct environment specification.

The addition of the -e dev flag is correct. The check-build task is defined with --feature dev in snakedeploy/scaffold_plugins/common.py (line 128), so explicitly specifying the dev environment ensures the task runs in the correct context.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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