cosmos / interchain-security

Interchain Security is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another.
https://cosmos.github.io/interchain-security/
Other
154 stars 115 forks source link

docs: update releases (bots and docs) #1948

Closed mpoke closed 3 months ago

mpoke commented 4 months ago

Description

Closes: NA


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough The changes involve updating configuration files to discontinue support for certain release branches (`release/v4.1.x`, `release/v4.1.x-lsm`) and adding new features and version updates in documentation files. This includes modifying dependency update rules, backporting rules, and updating feature availability and release/version tables. ## Changes | File | Change Summary | |---------------------------------|----------------------------------------------------------------------------------------------------| | `.github/dependabot.yml` | Removed configurations for automated security updates on `release/v4.1.x` and `release/v4.1.x-lsm` | | `.mergify.yml` | Removed backporting rules for `release/v4.1.x` and `release/v4.1.x-lsm` | | `FEATURES.md` | Updated feature availability, added new features for `v4.2.0` and `v4.2.0-lsm` | | `RELEASES.md` | Updated version information, discontinued certain versions, added new versions | ## Sequence Diagram(s) (Beta) ```mermaid sequenceDiagram participant User participant Dependabot participant Mergify participant Documentation User->>Dependabot: Remove security update configurations User->>Mergify: Remove backporting rules User->>Documentation: Update feature availability User->>Documentation: Update version information ```

Recent review details **Configuration used: .coderabbit.yml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 035377e95d6673b71f5cc916eff4b4a7cce9dc29 and 189fe6adb503b48e9055bd2b8bd7bc67ed0b372f.
Files selected for processing (4) * .github/dependabot.yml (1 hunks) * .mergify.yml (1 hunks) * FEATURES.md (1 hunks) * RELEASES.md (4 hunks)
Files skipped from review due to trivial changes (2) * .github/dependabot.yml * .mergify.yml
Additional context used
Path-based instructions (2)
FEATURES.md (1) Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."
RELEASES.md (1) Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."
Markdownlint
RELEASES.md
98-98: null (MD047, single-trailing-newline) Files should end with a single newline character --- 79-79: Expected: 6; Actual: 5; Too few cells, row will be missing data (MD056, table-column-count) Table column count --- 81-81: Expected: 6; Actual: 5; Too few cells, row will be missing data (MD056, table-column-count) Table column count --- 83-83: Expected: 6; Actual: 5; Too few cells, row will be missing data (MD056, table-column-count) Table column count
Additional comments not posted (6)
FEATURES.md (3)
`17-17`: The update on "Cryptographic verification of equivocation" accurately reflects its availability from version `v4.0.0` onwards. --- `20-20`: The update on "ICS epochs" accurately reflects its availability from version `v4.2.0` onwards. --- `21-21`: The update on "Partial Set Security" correctly indicates that it remains unavailable in version `v5.0.0`.
RELEASES.md (3)
`63-63`: The end of life date for `v4.2.x` is correctly set to January 24, 2025. --- `64-64`: The end of life date for `v5.0.0` is correctly set to May 9, 2025. --- `98-98`: Ensure the file ends with a single newline character. ```diff + ``` > Likely invalid or redundant comment.
Tools
Markdownlint
98-98: null (MD047, single-trailing-newline) Files should end with a single newline character
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mpoke commented 3 months ago

Does this need to be backported to v4.2.x and v4.2.x-lsm?

No.