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

build: specify commits that trigger a release #174

Merged
merged 1 commit into from
Nov 10, 2023

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Nov 9, 2023

Specify the commits that should trigger a release (cf. semantic-release/commit-analyzer), especially those affecting the project's behavior, for instance build(deps), build(deps-dev) and docs(schema) categories.


@amimart Need this to enable a new release of the indexer based on the latest subql dependencies.

Summary by CodeRabbit

  • Refactor
    • Updated the release rules for different commit types to define patch and minor releases more accurately.
    • Added a specific release rule for "docs" type with "schema" scope, which will now trigger a minor release.

Copy link

coderabbitai bot commented Nov 9, 2023

Walkthrough

The changes introduced in the .releaserc.yml file revolve around the enhancement of the semantic-release configuration. The modifications include the addition of specific release rules for various commit types and scopes, and the reformatting of the plugins configuration for improved readability.

Changes

File Change Summary
.releaserc.yml Introduced specific release rules for different commit types and scopes, specifying the patch or minor release for each type. Added a release rule for "docs" type with "schema" scope, specifying a minor release. Reformatted the plugins configuration for better alignment of nested properties.

Poem

🍂 As the leaves fall this November day, 🍁

CodeRabbit hopped along the way. 🐇

With each hop, a change was made, 📝

In the .releaserc.yml, a foundation laid. 🏗️

Release rules now clear and bright, 🌟

For each commit type, a release in sight. 👀

So let's celebrate this day with cheer, 🎉

For the code is evolving, have no fear! 🚀


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@ccamel ccamel self-assigned this Nov 9, 2023
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e323c57 and 2754fed.
Files selected for processing (1)
  • .releaserc.yml (1 hunks)
Additional comments: 1
.releaserc.yml (1)
  • 4-30: The changes to the releaseRules section of the plugins configuration are well-structured and follow the guidelines provided by the semantic-release/commit-analyzer. The new rules for build(deps), build(deps-dev), and docs(schema) commits are clear and should help automate the release process more effectively. The alignment of nested properties also improves readability.

@ccamel ccamel force-pushed the build/semantic-release-config branch from 2754fed to 9448776 Compare November 9, 2023 06:08
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e323c57 and 9448776.
Files selected for processing (1)
  • .releaserc.yml (1 hunks)
Additional comments: 1
.releaserc.yml (1)
  • 4-29: The changes to the semantic-release configuration look good. The addition of specific release rules for different commit types and scopes will help in automating the versioning process based on commit messages. The new rule for "docs" type with "schema" scope indicating a minor release is a good addition. Just ensure that the commit messages are written following the specified types and scopes for the rules to work as expected.

@ccamel ccamel requested a review from amimart November 9, 2023 06:18
@ccamel ccamel merged commit 7607f27 into main Nov 10, 2023
14 checks passed
@ccamel ccamel deleted the build/semantic-release-config branch November 10, 2023 16:30
@bot-anik
Copy link
Member

🎉 This PR is included in version 1.0.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants