change logs guide #919
Open
change logs guide #919
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
Signed-off-by: Jared Watts <[email protected]>
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
haarchri
reviewed
Apr 25, 2025
| It also assumes you have the [`jq` tool installed](https://jqlang.org/download/), | ||
| to perform lightweight querying and filtering of the content in the change logs. | ||
|
|
||
| The only other prerequisite for enabling change logs is that the provider must |
There was a problem hiding this comment.
i see folks asking how to detect if a provider includes the changelog feature. In the meantime, could we add a link tomain.go example from the provider-kubernetes project to help illustrate this? https://github.com/crossplane-contrib/provider-kubernetes/blob/3e694c4f2b644664167e67c58f3de8d2f9ffba0f/cmd/provider/main.go#L76
There was a problem hiding this comment.
yeah i was thinking that was going to be a likely question also 😂 - but i don't love the idea of having people go search through source code of their providers
another idea could be to look at the help output of the provider image, e.g.:
❯ docker run --rm xpkg.crossplane.io/crossplane-contrib/provider-kubernetes:v0.17.1 --help 2>&1 | grep enable-changelogs
❯ docker run --rm xpkg.crossplane.io/crossplane-contrib/provider-kubernetes:v0.18.0 --help 2>&1 | grep enable-changelogs
--[no-]enable-changelogs Enable support for capturing change logs during
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a guide for enabling and using the change logs feature. It walks through a simple scenario with
provider-kubernetesto enable change logs on the provider, create some resources and perform lifecycle operations on them, and how to check the change logs to learn more about the operations that were recorded.I encourage reviewers to walk through the guide on the preview site and verify it works for them too. I have done so multiple times on my machine, but it would be good to get further validation.
Fixed #806