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

Release 3 Changelog and Backport tags #676

Merged
merged 3 commits into from
Nov 28, 2024

Conversation

crnbarr93
Copy link
Contributor

@crnbarr93 crnbarr93 commented Nov 28, 2024

Motivation

Adds mergify support for release 3 backporting and fixes the changelog for release 3

Summary by CodeRabbit

  • New Features

    • Introduced a new pull request rule for backporting changes to the release/3 branch.
    • Added "Validator Staking ADO" and "Restake and Redelegate" features in the Release 3 section of the changelog.
  • Bug Fixes

    • Updated validations and fixes related to the vesting process and validator staking distribution messages.
  • Documentation

    • Enhanced organization of the CHANGELOG with clearer categories for changes.
  • Chores

    • Updated version numbers for andromeda-validator-staking and andromeda-vesting packages to indicate stable releases.

@crnbarr93 crnbarr93 added ci: skip-changelog Skips the changelog check in CI ci: skip-build Skip artifact uploads labels Nov 28, 2024
@crnbarr93 crnbarr93 requested a review from joemonem November 28, 2024 10:18
Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes in this pull request primarily involve updates to the .github/mergify.yml configuration for backporting rules, modifications to the CHANGELOG.md for better organization of entries, and version updates in the Cargo.toml files for the andromeda-validator-staking and andromeda-vesting packages. The new backport rule targets the release/3 branch when specific conditions are met, while the changelog adjustments clarify the categorization of changes. Additionally, the version numbers in the Cargo files indicate stable releases.

Changes

File Change Summary
.github/mergify.yml Added a new pull request rule for backporting to the release/3 branch when the base is development and the label backport/release/3 is applied.
CHANGELOG.md Updated to include new "Changed" and "Fixed" categories, removed "Added Curve ADO," added entries for "Validator Staking ADO" and "Restake and Redelegate," and refined overall structure.
contracts/finance/andromeda-validator-staking/Cargo.toml Updated version from 0.3.0-b.1 to 0.3.0, adjusted formatting for dependency line.
contracts/finance/andromeda-vesting/Cargo.toml Updated version from 3.0.4-b.2 to 3.0.4, maintained edition and Rust version, defined features and dependencies.

Possibly related PRs

Suggested labels

backport/v1.1.x

Suggested reviewers

  • joemonem
  • cowboy0015
  • SlayerAnsh

🐰 In the meadow, changes bloom,
A backport rule to lift the gloom.
Changelog dances, entries rearranged,
Versions updated, all nicely changed.
Hop along, let’s celebrate,
With every fix, we elevate! 🌼


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

@crnbarr93 crnbarr93 merged commit cea9f7e into development Nov 28, 2024
8 checks passed
@crnbarr93 crnbarr93 deleted the connor/release-3-changelog branch November 28, 2024 10:22
Copy link
Contributor

@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: 2

🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)

12-15: Consider removing empty sections from "Unreleased"

Since this PR is focused on Release 3, consider removing the empty "Changed" and "Fixed" sections from "Unreleased" unless there are imminent changes planned. Empty sections can make the changelog harder to scan.

### Added

-### Changed
-
-### Fixed
-
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 824c60a and e92a3ff.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • .github/mergify.yml (1 hunks)
  • CHANGELOG.md (1 hunks)
  • contracts/finance/andromeda-validator-staking/Cargo.toml (2 hunks)
  • contracts/finance/andromeda-vesting/Cargo.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • contracts/finance/andromeda-vesting/Cargo.toml
🔇 Additional comments (3)
.github/mergify.yml (1)

16-23: LGTM! The new backport rule follows best practices.

The rule is well-structured and maintains consistency with the existing backporting pattern. It correctly inherits the default assignees configuration and uses appropriate conditions for automated backporting.

contracts/finance/andromeda-validator-staking/Cargo.toml (1)

3-3: LGTM: Version update from beta to stable

The version change from "0.3.0-b.1" to "0.3.0" appropriately reflects the transition to a stable release.

CHANGELOG.md (1)

Line range hint 1-641: Overall changelog structure looks good!

The changelog follows the Keep a Changelog format consistently, with proper categorization and PR links for traceability.

Comment on lines +16 to +23
- name: backport to release/3 branch
conditions:
- base=development
- label=backport/release/3
actions:
backport:
branches:
- release/3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Based on the repository scan results, I can now provide a final response regarding the release/3 branch configuration:

The release/3 branch does not exist in the repository

The git remote check shows only the development branch exists, and there are no references to a release/3 branch in the codebase. The mergify configuration attempting to backport to a non-existent branch would fail.

🔗 Analysis chain

Verify the target branch configuration.

Let's ensure the target branch exists and has appropriate permissions set up.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the release/3 branch exists and has appropriate protection rules

# Check if the branch exists
git ls-remote --heads origin release/3

# Check branch protection rules using GitHub API
gh api repos/:owner/:repo/branches/release/3/protection

Length of output: 319


Script:

#!/bin/bash
# Let's check the existing branches and their recent activity
git branch -r

# Check if there are any references to release/3 in the repository
rg -i "release/3" -g "!.git"

# Let's also check the README or documentation for any mention of branch strategy
fd -g "README*" -X cat {}

Length of output: 52598

cw-orch-daemon = "0.24.2"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Workspace versioning should be implemented for cw-orch-daemon

The workspace is properly configured with [workspace.dependencies] section, but cw-orch-daemon is missing from it. Multiple versions (0.24.2 and 0.24.3) are currently used across different packages, which could lead to compatibility issues.

  • Add cw-orch-daemon to workspace dependencies in root Cargo.toml
  • Update all package-level dependencies to use workspace versioning
  • Consider upgrading to the latest version 0.28.1 after checking for breaking changes

Example fix:

# In root Cargo.toml [workspace.dependencies]:
cw-orch-daemon = "0.24.3"  # or "0.28.1" after checking compatibility

# In package Cargo.toml files:
cw-orch-daemon = { workspace = true }
🔗 Analysis chain

Consider using workspace versioning for cw-orch-daemon

The newly added dependency uses a fixed version which could lead to version inconsistencies across the workspace and potential security vulnerabilities if not maintained.

Run this script to check for the latest version and any potential security advisories:

Consider using workspace versioning like other dependencies:

-cw-orch-daemon = "0.24.2"
+cw-orch-daemon = { workspace = true }

Multiple versions of cw-orch-daemon found across workspace, needs standardization

  • packages/andromeda-testing-e2e uses version 0.24.3
  • All other packages use version 0.24.2
  • Latest version available is 0.28.1

Let me verify if workspace dependencies are already set up to determine the best recommendation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify cw-orch-daemon version and usage across workspace

# Check if cw-orch-daemon is defined in workspace dependencies
rg '"cw-orch-daemon"' -A 1 Cargo.toml

# Find all usages of cw-orch-daemon in workspace
rg 'cw-orch-daemon = ".+"' 

# Check latest version from crates.io
curl -s https://crates.io/api/v1/crates/cw-orch-daemon | jq -r '.crate.max_version'

Length of output: 732


Script:

#!/bin/bash
# Check if workspace dependencies are defined in root Cargo.toml
rg '\[workspace\.dependencies\]' -A 30 Cargo.toml

# Check if there's a workspace definition that includes these packages
rg '\[workspace\]' -A 10 Cargo.toml

Length of output: 1713

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci: skip-build Skip artifact uploads ci: skip-changelog Skips the changelog check in CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants