docs: add CHANGELOG with v0.20.0 entry#34
Merged
Conversation
WalkthroughThe changelog adds the v0.20.0 release entry, documenting expanded API and CLI coverage, SDK-breaking changes, updated config-file partial-update behavior, and the release reference link. ChangesRelease Documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CHANGELOG.md`:
- Around line 15-33: Restructure the CHANGELOG breaking-changes section by
moving the `dhq launch --dry-run --json` monthly_cost bullet out of `Breaking
(SDK)` and into a new dedicated `Breaking (CLI)` section. Keep the SDK bullets
together and preserve the existing currency-aware migration details in the CLI
section.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+15
to
+33
| ### Breaking (SDK) | ||
|
|
||
| These affect external importers of `github.com/deployhq/deployhq-cli/pkg/sdk` and | ||
| scripts that parse the JSON output of existing commands. They correct types that | ||
| never matched the live API (the old fields were populated from a response shape | ||
| the backend does not return), so end-user behaviour of `dhq launch` is fixed | ||
| rather than regressed. | ||
|
|
||
| - **`ManagedHostingSize`**: renamed `Description` → `Label` and | ||
| `PriceMonthly` → `MonthlyCost`; removed `PriceHourly`, `Memory`, `VCPUs`, | ||
| `Disk`; added `Currency`. Matches the `{ "sizes": [...] }` envelope from | ||
| `GET /managed_hosting/sizes`. | ||
| - **`ManagedHostingRegion`**: removed `Available`; added `Flag` and `Country`. | ||
| Regions are now served grouped (`{ "grouped_regions": {...} }`). | ||
| - **`Client.UpdateConfigFile`**: now takes `ConfigFileUpdateRequest` (all-pointer | ||
| fields for partial updates) instead of `ConfigFileCreateRequest`. | ||
| - **`dhq launch --dry-run --json`**: `monthly_cost` is now currency-aware | ||
| (e.g. `£12.00`, `12.00 SEK`) instead of always `$X.XX`. Update any parser that | ||
| assumes a leading `$`. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Separate the CLI breaking change from the SDK section.
dhq launch --dry-run --json changes the CLI JSON contract, not pkg/sdk. Move this bullet into a dedicated Breaking (CLI) section so SDK consumers and JSON-output parsers can identify the migration they need.
Suggested structure
### Breaking (SDK)
- **Client.UpdateConfigFile**: now takes `ConfigFileUpdateRequest` ...
+### Breaking (CLI)
+
+- **`dhq launch --dry-run --json`**: `monthly_cost` is now currency-aware ...
+
### Added📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ### Breaking (SDK) | |
| These affect external importers of `github.com/deployhq/deployhq-cli/pkg/sdk` and | |
| scripts that parse the JSON output of existing commands. They correct types that | |
| never matched the live API (the old fields were populated from a response shape | |
| the backend does not return), so end-user behaviour of `dhq launch` is fixed | |
| rather than regressed. | |
| - **`ManagedHostingSize`**: renamed `Description` → `Label` and | |
| `PriceMonthly` → `MonthlyCost`; removed `PriceHourly`, `Memory`, `VCPUs`, | |
| `Disk`; added `Currency`. Matches the `{ "sizes": [...] }` envelope from | |
| `GET /managed_hosting/sizes`. | |
| - **`ManagedHostingRegion`**: removed `Available`; added `Flag` and `Country`. | |
| Regions are now served grouped (`{ "grouped_regions": {...} }`). | |
| - **`Client.UpdateConfigFile`**: now takes `ConfigFileUpdateRequest` (all-pointer | |
| fields for partial updates) instead of `ConfigFileCreateRequest`. | |
| - **`dhq launch --dry-run --json`**: `monthly_cost` is now currency-aware | |
| (e.g. `£12.00`, `12.00 SEK`) instead of always `$X.XX`. Update any parser that | |
| assumes a leading `$`. | |
| ### Breaking (SDK) | |
| These affect external importers of `github.com/deployhq/deployhq-cli/pkg/sdk` and | |
| scripts that parse the JSON output of existing commands. They correct types that | |
| never matched the live API (the old fields were populated from a response shape | |
| the backend does not return), so end-user behaviour of `dhq launch` is fixed | |
| rather than regressed. | |
| - **`ManagedHostingSize`**: renamed `Description` → `Label` and | |
| `PriceMonthly` → `MonthlyCost`; removed `PriceHourly`, `Memory`, `VCPUs`, | |
| `Disk`; added `Currency`. Matches the `{ "sizes": [...] }` envelope from | |
| `GET /managed_hosting/sizes`. | |
| - **`ManagedHostingRegion`**: removed `Available`; added `Flag` and `Country`. | |
| Regions are now served grouped (`{ "grouped_regions": {...} }`). | |
| - **`Client.UpdateConfigFile`**: now takes `ConfigFileUpdateRequest` (all-pointer | |
| fields for partial updates) instead of `ConfigFileCreateRequest`. | |
| ### Breaking (CLI) | |
| - **`dhq launch --dry-run --json`**: `monthly_cost` is now currency-aware | |
| (e.g. `£12.00`, `12.00 SEK`) instead of always `$X.XX`. Update any parser that | |
| assumes a leading `$`. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CHANGELOG.md` around lines 15 - 33, Restructure the CHANGELOG
breaking-changes section by moving the `dhq launch --dry-run --json`
monthly_cost bullet out of `Breaking (SDK)` and into a new dedicated `Breaking
(CLI)` section. Keep the SDK bullets together and preserve the existing
currency-aware migration details in the CLI section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the first
CHANGELOG.mdfor the CLI ahead of the v0.20.0 release.Documents the API-coverage expansion landed in #31, #32, #33, and calls out the breaking
pkg/sdkchanges from #32 (theManagedHostingSize/ManagedHostingRegionfield changes and theUpdateConfigFilesignature) under an explicit Breaking (SDK) section, so the minor bump is justified and discoverable.Once merged,
v0.20.0will be tagged on the merge commit to trigger GoReleaser.🤖 Generated with Claude Code
Summary by CodeRabbit