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(release): include Cargo.toml in release commit process #675

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Dec 13, 2024

Self explanatory.

Summary by CodeRabbit

  • Chores
    • Updated the release configuration for handling Cargo.toml files.

@ccamel ccamel self-assigned this Dec 13, 2024
Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request modifies the semantic release configuration in the .releaserc.cjs file. It specifically updates the assets list for the @semantic-release/git plugin by removing references to "contracts/*/Cargo.toml" and "packages/*/Cargo.toml" and replacing them with a direct reference to "Cargo.toml". The overall structure of the configuration remains unchanged, with no modifications to other plugins or their settings.

Changes

File Change Summary
.releaserc.cjs Updated assets in @semantic-release/git: removed "contracts/*/Cargo.toml" and "packages/*/Cargo.toml", added "Cargo.toml"

Possibly related PRs

  • ci(workflow): restrict crate publication trigger to new releases #674: The changes in the .github/workflows/publish.yml file regarding the trigger for crate publication are related to the overall release process, which is also impacted by the modifications in the .releaserc.cjs file in the main PR. Both PRs focus on refining how releases are handled in the project.

🐇 In the meadow, a change took flight,
Cargo.toml shines, oh what a sight!
Patterns removed, simplicity's grace,
Semantic release finds its new place.
Hopping along, we celebrate cheer,
With every release, our vision is clear! 🌼


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?

❤️ Share
🪧 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. (Experiment)
  • @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

🧹 Outside diff range and nitpick comments (1)
.releaserc.cjs (1)

110-110: Consider adding a comment explaining the workspace-based versioning.

To help future maintainers understand why only the root Cargo.toml is included, consider adding a comment in the configuration explaining that versions are managed through the workspace manifest.

 "@semantic-release/git",
 {
   assets: [
     "CHANGELOG.md",
     "docs/**",
+    // Only include root Cargo.toml as it's the workspace manifest managing versions
     "Cargo.toml",
     "Cargo.lock",
   ],
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5c895a3 and 9ffd795.

📒 Files selected for processing (1)
  • .releaserc.cjs (1 hunks)
🔇 Additional comments (1)
.releaserc.cjs (1)

110-110: LGTM! Verify workspace structure.

The change to include only the root Cargo.toml is correct since it appears to be a workspace manifest that manages versions for all member crates.

Let's verify the workspace structure:

✅ Verification successful

Workspace structure verified - root Cargo.toml manages all crates

The verification confirms that:

  • Root Cargo.toml is indeed a workspace manifest managing all crates
  • Workspace members include all crates under contracts/* and packages/*
  • All existing Cargo.toml files (4 contracts, 6 packages) are properly covered by the workspace patterns

The change to include only the root Cargo.toml in semantic release is correct since it manages versions for all workspace members.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that root Cargo.toml is a workspace manifest
# and contains all necessary member references

# Check if root Cargo.toml exists and contains workspace members
rg -A 5 "^\[workspace\]" Cargo.toml

# List all Cargo.toml files in the repository for reference
fd Cargo.toml

Length of output: 544

@bot-anik
Copy link
Member

size-limit report 📦

Path Size
target/wasm32-unknown-unknown/release/axone_objectarium.wasm 458.07 KB (0%)
target/wasm32-unknown-unknown/release/axone_law_stone.wasm 593.03 KB (0%)
target/wasm32-unknown-unknown/release/axone_cognitarium.wasm 882.05 KB (0%)
target/wasm32-unknown-unknown/release/axone_dataverse.wasm 697.14 KB (0%)

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@ccamel ccamel merged commit 6b637ba into main Dec 13, 2024
18 checks passed
@ccamel ccamel deleted the ci/fix-semantic-release-git branch December 13, 2024 19:04
This was referenced Dec 13, 2024
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.

2 participants