docs: update the action how-to to explain the additionalProperties default flip #2249
Conversation
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
tonyandrewmeyer
force-pushed
the
update-docs-additionalProperties
branch
from
5807472 to
a53d3bb
Compare
james-garner-canonical
approved these changes
Dec 18, 2025
Collaborator
Author
|
@james-garner-canonical I realised after opening this that it would be good to change the tutorial charm as well, so I've added that. Feel free to re-review or not as you please. |
Co-authored-by: Dave Wilding <tech@dpw.me>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents the breaking change in Juju 4 where the default value of additionalProperties flips from true to false. The documentation update guides users to explicitly set this field to ensure consistent behavior across Juju 3 and Juju 4 deployments.
- Adds a prominent note to the actions how-to guide explaining the default value change
- Updates all action examples to explicitly include the
additionalPropertiesfield
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/howto/manage-actions.md | Adds documentation explaining the additionalProperties default change between Juju 3 and 4 |
| examples/k8s-5-observe/charmcraft.yaml | Adds explicit additionalProperties: false to action definition |
| examples/k8s-4-action/charmcraft.yaml | Adds explicit additionalProperties: False to action definition |
| docs/tutorial/from-zero-to-hero-write-your-first-kubernetes-charm/expose-operational-tasks-via-actions.md | Adds explicit additionalProperties: False to tutorial action example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.../from-zero-to-hero-write-your-first-kubernetes-charm/expose-operational-tasks-via-actions.md
Outdated
Show resolved
Hide resolved
…arm/expose-operational-tasks-via-actions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Juju 4 flips the default value of
additionalPropertiesfromtruetofalse(see juju/juju#21294). Add a note to the actions how-to guide that lets people know this and that they need to explicitly include the field if they want to ensure compatibility across Juju 3 and Juju 4.