Repository navigation
docs(release): fix broken links and PR refs in v1.4.0 changelog - #2693
Conversation
- Resource Presets doc URL: /docs/operations/resource-presets/ → /docs/v1.4/guides/resource-management/ (was 404) - HAMi doc URL: /docs/operations/kubernetes/hami/ → /docs/v1.4/kubernetes/gpu-sharing/ (was 404) - Upgrade-notes PR ref for presets: #2426 → #2607 - Upgrade-notes PR ref for postgres parameters: #2475 → #2466 Assisted-By: Claude <[email protected]> Signed-off-by: Myasnikov Daniil <[email protected]>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses inaccuracies in the v1.4.0 release documentation. It resolves broken hyperlinks to external documentation and updates references to specific pull requests in the upgrade notes to ensure users are directed to the correct implementation details. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on Gemini (@gemini-code-assist) comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
github-actions
Bot
added
the
size/XS
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe v1.4.0 changelog is updated with corrected documentation links pointing to v1.4 guides and refreshed PR numbers in the Upgrade Notes section, while preserving all described behaviors and semantics. Changesv1.4.0 Changelog Reference Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
area/release
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the v1.4.0 changelog by correcting broken documentation links and fixing incorrect PR references for resource presets and PostgreSQL parameter type-checking. Feedback was provided regarding the PR title, which uses an invalid scope ('release') according to the repository's Conventional Commits style guide; the reviewer suggested using a valid scope such as 'docs' for consistency.
| Each series ships eight sizes (`nano` → `4xlarge`). The seven legacy flat names (`nano` … `2xlarge`) are kept as deprecated aliases that map 1:1 by CPU and memory, so `helm template ... --set resourcesPreset=small` still renders `1 CPU / 512Mi` exactly as before. **Migration 39** walks every `HelmRelease.spec.values` and every app CR under `apps.cozystack.io/v1alpha1` and rewrites legacy values to their instance-type equivalents (`small → t1.small`, `medium → c1.small`, etc); the migration is idempotent and dry-runnable via `MIGRATION_DRY_RUN=1`. The `cozystack-api` emits deprecation warnings on every `Create`/`Update` against an app CR that still carries a legacy value, naming the JSON path and the 1:1 replacement. | ||
|
|
||
| Operators see no behavioural change on upgrade — defaults preserve resources exactly. New deployments get the richer taxonomy and can select an explicit CPU/memory ratio per workload. See [Resource Presets](https://cozystack.io/docs/operations/resource-presets/) for the full size matrix ([**@lexfrei**](https://github.com/lexfrei) and [**@matthieu-robin**](https://github.com/matthieu-robin) in #2607). | ||
| Operators see no behavioural change on upgrade — defaults preserve resources exactly. New deployments get the richer taxonomy and can select an explicit CPU/memory ratio per workload. See [Resource Presets](https://cozystack.io/docs/v1.4/guides/resource-management/) for the full size matrix ([**@lexfrei**](https://github.com/lexfrei) and [**@matthieu-robin**](https://github.com/matthieu-robin) in #2607). |
There was a problem hiding this comment.
The PR title docs(release): ... does not fully align with the repository's Conventional Commits style guide. While docs is a valid type, release is not a listed scope.
For consistency with the project's contribution guidelines, please consider updating the title to use a valid scope, such as docs. For example: docs(docs): fix broken links and PR refs in v1.4.0 changelog.
References
- Commits must follow the Conventional Commits format
type(scope): brief description. Thescopemust be one of the valid scopes defined in the repository style guide (lines 40-46). The scopereleaseis not in this list, whiledocsis a valid meta-scope. (link)
2 participants
What this PR does
Follow-up to #2675. Fixes four broken references in
docs/changelogs/v1.4.0.mdthat were caught by re-verifying every link in the merged changelog:cozystack.io/docs/operations/resource-presets/(404)cozystack.io/docs/v1.4/guides/resource-management/cozystack.io/docs/operations/kubernetes/hami/(404)cozystack.io/docs/v1.4/kubernetes/gpu-sharing/#2426(feat(monitoring): upgrade victoria-metrics-operator)#2607(feat(apps): instance-type resource presets)#2475(unrelated open issue about bundle YAML)#2466(feat(postgres)!: support all PostgreSQL configuration parameters)The Feature Highlights / Major Features sections already cited #2607 and #2466 correctly; only the Upgrade Notes section pointed at the wrong PR numbers.
Release note
Summary by CodeRabbit