Skip to content

Conversation

@m-jahn
Copy link
Member

@m-jahn m-jahn commented Nov 12, 2025

  • found out with the previous PR that the current release-please action is not working anymore :-(
  • this PR updates the release-please and conventional-prs actions to latest version
  • also adds the missing mandatory directory in the README example

Summary by CodeRabbit

  • Chores
    • Updated CI/CD workflows to enhance PR validation and streamline release automation
    • Updated documentation examples to reflect latest tool versions

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

📝 Walkthrough

Walkthrough

The PR updates GitHub Actions workflows to newer action versions and simplifies release automation. The conventional PR validation workflow upgrades to action v6 with explicit trigger events. The release workflow migrates from GoogleCloudPlatform to googleapis release-please action v4, removing manual git operations and adding permission declarations. README documentation examples for Snakemake actions are updated from v1 to v2 with normalized YAML formatting.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow Updates
.github/workflows/conventional-prs.yml
Workflow name changed from "PR" to "Lint PR"; trigger events explicitly listed (opened, reopened, edited, synchronize); permissions added for read:pull-requests; job key changed from "title-format" to "main"; action version updated from amannn/[email protected] to @v6; environment variable GITHUB_TOKEN updated with new syntax
GitHub Actions Workflow Updates
.github/workflows/release-please.yml
Action replaced from GoogleCloudPlatform/release-please-action@v2 to googleapis/release-please-action@v4; top-level permissions block added (write: contents, pull-requests, issues); checkout step and manual git operations removed; workflow inputs simplified to use token authentication; release-type input retained but with updated action semantics
Documentation
README.md
Snakemake GitHub Action examples updated from v1 to v2; YAML normalized with consistent double-quote formatting; directory and snakefile path references updated with consistent quotes

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • release-please.yml: Major version bump (v2 → v4) with significant workflow restructuring; verify that removal of manual tagging and git operations doesn't introduce regressions
  • conventional-prs.yml: Action version upgrade (v3.4.0 → v6); confirm trigger events and permission changes align with intended PR validation behavior
  • README.md: Documentation alignment with action version changes; verify examples remain functional

Suggested reviewers

  • johanneskoester
  • dlaehnemann
  • tedil

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: defunct release-please action' accurately describes the primary change: updating the non-functional release-please action to a working version, which aligns with the PR's main objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 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 73be4c1 and 7fac3c2.

📒 Files selected for processing (3)
  • .github/workflows/conventional-prs.yml (2 hunks)
  • .github/workflows/release-please.yml (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-12-09T16:41:37.740Z
Learnt from: johanneskoester
Repo: snakemake/snakemake-github-action PR: 39
File: action.yml:70-73
Timestamp: 2024-12-09T16:41:37.740Z
Learning: In Snakemake workflows, Snakemake itself provides proper error messages during the containerization step, so additional error handling in the GitHub Action script is unnecessary.

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (4)
README.md (1)

35-39: Well-structured documentation updates for v2 action.

The examples now consistently include the mandatory directory input, addressing the PR objective. Version bumps to v2 and YAML normalization improve consistency and readability across all three examples (Linting, Testing, and containerize tasks).

Also applies to: 42-48, 51-55

.github/workflows/conventional-prs.yml (1)

18-18: Verify v6 action input compatibility.

The update from amannn/[email protected] to v6 is a significant version bump. The GITHUB_TOKEN is still passed via env var, but confirm that v6 still accepts this input method and hasn't changed to a with: input.

Additionally, confirm that the new pull_request_target trigger (lines 3-8) with explicit event types aligns with the action's PR title validation expectations—specifically, that context and PR metadata are properly accessible on edited and synchronize events.

Also applies to: 20-20

.github/workflows/release-please.yml (2)

17-20: Verify googleapis release-please-action@v4 functionality with simplified inputs.

The migration from GoogleCloudPlatform to googleapis release-please action is a significant update (v2 → v4). The configuration is now minimal (only token and release-type), whereas the previous version likely required additional inputs like package-name.

Confirm that:

  1. The googleapis action with only token and release-type: go generates releases and changelog updates correctly.
  2. release-type: go aligns with the intended behavior (changelog-only versioning, no version in code files).
  3. No additional inputs or configuration are needed for this repository's release workflow.

6-9: Permissions scope is appropriate for release automation.

The top-level permissions block correctly grants write access to contents, pull-requests, and issues, which are necessary for the googleapis release-please action to create releases, manage PRs, and close related issues.


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