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

ci: update conventional-prs.yaml GitHub Actions version #250

Merged

Conversation

dlaehnemann
Copy link
Member

@dlaehnemann dlaehnemann commented Mar 14, 2025

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflows to use newer versions of release management tools, enhancing the automation process for pull requests and releases. This change does not directly impact the user experience.
    • Removed Python version 3.8 from the CI testing matrix, now testing with versions 3.9, 3.10, 3.11, and 3.12.

@dlaehnemann dlaehnemann requested a review from mbhall88 as a code owner March 14, 2025 13:33
Copy link

coderabbitai bot commented Mar 14, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • poetry.lock is excluded by !**/*.lock
  • pyproject.toml is excluded by !pyproject.toml

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The GitHub Actions workflows have been updated in three files. In .github/workflows/conventional-prs.yaml, the version of the amannn/action-semantic-pull-request action was changed from v3.4.0 to v5. In .github/workflows/release-please.yaml, the action was updated from GoogleCloudPlatform/release-please-action@v2 to googleapis/release-please-action@v4, with the removal of the package-name and bump-minor-pre-major parameters, and the addition of a token parameter that utilizes a secret for authentication. Additionally, in .github/workflows/ci.yaml, Python version 3.8 was removed from the testing matrix.

Changes

File Change Summary
.github/workflows/conventional-prs.yaml Updated amannn/action-semantic-pull-request version from v3.4.0 to v5.
.github/workflows/release-please.yaml Updated googleapis/release-please-action version from v2 to v4, removed package-name and bump-minor-pre-major parameters, added token parameter utilizing ${{ secrets.RELEASE_PLEASE_PR_CI_TOKEN }}.
.github/workflows/ci.yaml Removed Python version 3.8 from the testing matrix.

🪧 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.

@dlaehnemann
Copy link
Member Author

Setting bump-minor-pre-major would now require a manifest file. Thus, if we want to keep this, we should add it back as a manifest file, which we could bootstrap with the release-please cli.
@mbhall88 , what do you think? Should we add this back in via a manifest file, or should we go for a v1.0 release some time soon, anyways?

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 (1)
.github/workflows/ci.yaml (1)

29-36: Ensure Consistent Naming Conventions for Workflow Steps

The new step correctly uploads the Poetry installer error logs as artifacts, enhancing error visibility. However, consider updating the step name to use Title Case (e.g., "Upload Poetry Error Log as Artifact") for consistency with the naming conventions observed in the other steps.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6d9bdfa and bebda79.

📒 Files selected for processing (1)
  • .github/workflows/ci.yaml (1 hunks)

@dlaehnemann
Copy link
Member Author

Another change I had to make: the latest poetry (2.1.1 at the time of writing) does not support python 3.8 any more, so I removed this from testing. Would we need to add a new minimum requirement of python >=3.9 anywhere, then?

@jakevc
Copy link

jakevc commented Mar 14, 2025

maybe requires-python = ">=3.9,<4.0" in [project] section of pyproject.toml

@dlaehnemann
Copy link
Member Author

Thanks for chiming in, @jakevc . Upon looking again, I think this should do it:
ff42658

@johanneskoester johanneskoester merged commit 3d13987 into master Mar 14, 2025
10 checks passed
@johanneskoester johanneskoester deleted the ci/update-actions-versions-add-release-please-token branch March 14, 2025 21:28
@github-project-automation github-project-automation bot moved this from In review to Done in Snakemake Hackathon March 2025 Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants