Skip to content

Conversation

@aljoshare
Copy link

@aljoshare aljoshare commented Oct 28, 2022

Issue #, if available: Not available

Description of changes:
In order to clarify the use of the id and status field of the lifecycle spec, this PR adds description fields to both.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Signed-off-by: Aljoscha Poertner <aljoscha.poertner@hellmann.com>
Signed-off-by: Aljoscha Poertner <aljoscha.poertner@hellmann.com>
@ack-bot ack-bot requested review from jaypipes and vijtrip2 October 28, 2022 13:00
@ack-bot
Copy link
Collaborator

ack-bot commented Oct 28, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: AljoschaP
To complete the pull request process, please assign vijtrip2 after the PR has been reviewed.
You can assign the PR to them by writing /assign @vijtrip2 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ack-bot
Copy link
Collaborator

ack-bot commented Oct 28, 2022

Hi @AljoschaP. Thanks for your PR.

I'm waiting for a aws-controllers-k8s member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ack-bot ack-bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 28, 2022
Copy link
Contributor

@jaypipes jaypipes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @AljoschaP!

Unfortunately, all of these YAML files are actually auto-generated by controller-gen after it looks at the Go type definitions in the apis/v1alpha1 directory.

So, the next time the S3 controller is regenerated (which happens very often as new runtimes and aws-sdk-go's are released), the changes introduced in this PR would be overwritten.

If a field in a resource has an associated Documentation string in the API's documentation file (here is the S3 one: https://github.com/aws/aws-sdk-go/blob/main/models/apis/s3/2006-03-01/docs-2.json) then our code generation tooling should pick up that Documentation string. I will have to look into why these particular fields aren't getting any documentation inserted.

@jaypipes jaypipes added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 1, 2022
@aljoshare
Copy link
Author

Hi @jaypipes :-) Thank you for the clarification! That makes a lot of sense 👍 Sorry for the noise 🤦‍♂️ Should I close the PR and create an issue instead?

@jaypipes
Copy link
Contributor

jaypipes commented Nov 7, 2022

Hi @jaypipes :-) Thank you for the clarification! That makes a lot of sense +1 Sorry for the noise man_facepalming Should I close the PR and create an issue instead?

Hi @AljoschaP sorry for the late response! Yes, please do create a GH issue that explains the issue. Thank you! :)

@aljoshare
Copy link
Author

Corresponding issue: aws-controllers-k8s/community#1540

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants