feat: add annotations for rollout #93
Conversation
WalkthroughThis pull request involves version updates and the addition of an Changes
Possibly related PRs
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
sofiasimdianova
force-pushed
the
feat/add-annotations
branch
from
2baf865 to
f6d8f25
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
8-14: Document the new annotations feature.Consider adding a note in the main README about the new annotations feature and its purpose for rollouts, or link to where this feature is documented in the individual chart READMEs.
🧰 Tools
🪛 LanguageTool
[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3034 characters long)
Context: ...tions, users, roles, and permissions. || | Portal | 1.2.0 |191a441519a65dae56a5b2cf56fe64eee03fc059 | Formance Portal |
| | Regions | 2.7.0 |latest | Formance Private Regions Helm Chart |
| | Stargate | 0.6.0 |latest | Formance Stargate gRPC Gateway | [
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (18)
charts/cloudprem/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/cloudprem/Chart.yamlis excluded by!**/*.yamlcharts/console-v3/Chart.yamlis excluded by!**/*.yamlcharts/console-v3/templates/deployment.yamlis excluded by!**/*.yamlcharts/console-v3/values.schema.jsonis excluded by!**/*.jsoncharts/console-v3/values.yamlis excluded by!**/*.yamlcharts/console/Chart.yamlis excluded by!**/*.yamlcharts/console/templates/deployment.yamlis excluded by!**/*.yamlcharts/console/values.schema.jsonis excluded by!**/*.jsoncharts/console/values.yamlis excluded by!**/*.yamlcharts/membership/Chart.yamlis excluded by!**/*.yamlcharts/membership/templates/deployment.yamlis excluded by!**/*.yamlcharts/membership/values.schema.jsonis excluded by!**/*.jsoncharts/membership/values.yamlis excluded by!**/*.yamlcharts/portal/Chart.yamlis excluded by!**/*.yamlcharts/portal/templates/deployment.yamlis excluded by!**/*.yamlcharts/portal/values.schema.jsonis excluded by!**/*.jsoncharts/portal/values.yamlis excluded by!**/*.yaml
📒 Files selected for processing (6)
README.md(1 hunks)charts/cloudprem/README.md(5 hunks)charts/console-v3/README.md(2 hunks)charts/console/README.md(2 hunks)charts/membership/README.md(2 hunks)charts/portal/README.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- charts/portal/README.md
- charts/console/README.md
- charts/membership/README.md
- charts/console-v3/README.md
- charts/cloudprem/README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3034 characters long)
Context: ...tions, users, roles, and permissions. | 
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Tests
| | [Cloudprem](./charts/cloudprem/README.md) | 2.2.0 |v0.36.2 | Formance control-plane | [](https://artifacthub.io/packages/search?repo=cloudprem) | | ||
| | [Console](./charts/console/README.md) | 1.2.0 |fccc26c5b568781b86fbd06c651399c0edd67bac | Formance Console | [](https://artifacthub.io/packages/search?repo=console) | | ||
| | [Console-V3](./charts/console-v3/README.md) | 1.2.0 |368ae6f5bd0a51bd5d9ebc0248a866869df5e326 | Formance Console | [](https://artifacthub.io/packages/search?repo=console-v3) | | ||
| | [Core](./charts/core/README.md) | 1.1.0 |latest | Formance Core Library | [](https://artifacthub.io/packages/search?repo=core) | | ||
| | [Demo](./charts/demo/README.md) | 2.1.0 |latest | Formance Private Regions Demo | [](https://artifacthub.io/packages/search?repo=demo) | | ||
| | [Membership](./charts/membership/README.md) | 1.1.1 |v0.36.2 | Formance Membership API. Manage stacks, organizations, regions, invitations, users, roles, and permissions. | [](https://artifacthub.io/packages/search?repo=membership) | | ||
| | [Portal](./charts/portal/README.md) | 1.1.0 |191a441519a65dae56a5b2cf56fe64eee03fc059 | Formance Portal | [](https://artifacthub.io/packages/search?repo=portal) | | ||
| | [Membership](./charts/membership/README.md) | 1.2.0 |v0.36.2 | Formance Membership API. Manage stacks, organizations, regions, invitations, users, roles, and permissions. | [](https://artifacthub.io/packages/search?repo=membership) | | ||
| | [Portal](./charts/portal/README.md) | 1.2.0 |191a441519a65dae56a5b2cf56fe64eee03fc059 | Formance Portal | [](https://artifacthub.io/packages/search?repo=portal) | |
There was a problem hiding this comment.
💡 Codebase verification
Annotations implementation is incomplete and undocumented
- The
annotationsproperty is only defined incloudpremandconsole-v3charts, missing in others - Documentation for the new annotations feature is missing in all chart README files
🔗 Analysis chain
Verify version bump consistency across charts.
The version increments follow semantic versioning and appear appropriate for adding new features. However, let's verify the changes are consistent across all chart files.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify version updates and annotations property in chart files
# Check version updates in Chart.yaml files
for chart in cloudprem console console-v3 membership portal; do
echo "Checking $chart Chart.yaml:"
cat "./charts/$chart/Chart.yaml" | grep -E "version:|annotations:"
done
# Check for annotations documentation in README files
for chart in cloudprem console console-v3 membership portal; do
echo "Checking $chart README.md for annotations documentation:"
grep -A 5 "annotations:" "./charts/$chart/README.md" || echo "No annotations documentation found"
done
Length of output: 2904
🧰 Tools
🪛 LanguageTool
[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 3034 characters long)
Context: ...tions, users, roles, and permissions. |
(EN_EXCESSIVE_EXCLAMATION)
Add annotations for the deployment template