Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

batch: Docstring defining default value of updateToLatestImageVersion property of ManagedComputeEnvironmentProps was not updated to false when releasing stable API #33582

Closed
dillon-odonovan opened this issue Feb 26, 2025 · 2 comments · Fixed by #33594
Closed

batch: Docstring defining default value of updateToLatestImageVersion property of ManagedComputeEnvironmentProps was not updated to false when releasing stable API #33582

dillon-odonovan opened this issue Feb 26, 2025 · 2 comments · Fixed by #33594
Assignees
@ashishdhingra
Labels
@aws-cdk/aws-batch Related to AWS Batch documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@dillon-odonovan
Copy link
Contributor

Describe the issue

In #27059 the default behavior of updateToLatestImageVersion was updated to be undefined instead of true. This change was accurately captured in the documentation of updateToLatestImageVersion defined in IManagedComputeEnvironment, but not in ManagedComputeEnvironmentProps.

Diff for adjusted behavior: https://github.com/aws/aws-cdk/pull/27059/files#diff-7ae09067a7ce8a58d494da3c01be13161be021e9cdb96008221d6e16cd0366b3L220

Links
@dillon-odonovan dillon-odonovan added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Feb 26, 2025
@github-actions github-actions bot added the @aws-cdk/aws-batch Related to AWS Batch label Feb 26, 2025
@ashishdhingra ashishdhingra self-assigned this Feb 26, 2025
@ashishdhingra ashishdhingra added p2 effort/small Small work item – less than a day of effort labels Feb 26, 2025
@ashishdhingra
Copy link
Contributor

ashishdhingra commented Feb 26, 2025 •
edited
Loading

Looking at the diff, this appears to be missed update of documentation string.

Created PR #33594

@ashishdhingra ashishdhingra mentioned this issue Feb 26, 2025
Merged
1 task
@ashishdhingra ashishdhingra removed the needs-triage This issue or PR still needs to be triaged. label Feb 26, 2025
@mergify mergify bot closed this as completed in #33594 Feb 28, 2025
mergify bot pushed a commit that referenced this issue Feb 28, 2025
@ashishdhingra
chore(batch): corrected the documentation string for updateToLatestIm…
528e5df 
…ageVersion in ManagedComputeEnvironmentProps. (#33594)

### Issue # (if applicable)

Closes #33582.

### Reason for this change
Documentation string for `updateToLatestImageVersion` in `ManagedComputeEnvironmentProps` was incorrect w.r.t. changes introduced in [diff](https://github.com/aws/aws-cdk/pull/27059/files#diff-7ae09067a7ce8a58d494da3c01be13161be021e9cdb96008221d6e16cd0366b3).

### Description of changes
Corrected the documentation string for `updateToLatestImageVersion` in `ManagedComputeEnvironmentProps`. (taken from [IManagedComputeEnvironment](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts#L97-L99))

### Describe any new or updated permissions being added
N/A


### Description of how you validated changes
N/A (simple documentation fix)

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 28, 2025
hwum pushed a commit to hwum/aws-cdk that referenced this issue Mar 3, 2025
@ashishdhingra @hwum
chore(batch): corrected the documentation string for updateToLatestIm…
1dbd9dc 
…ageVersion in ManagedComputeEnvironmentProps. (aws#33594)

### Issue # (if applicable)

Closes aws#33582.

### Reason for this change
Documentation string for `updateToLatestImageVersion` in `ManagedComputeEnvironmentProps` was incorrect w.r.t. changes introduced in [diff](https://github.com/aws/aws-cdk/pull/27059/files#diff-7ae09067a7ce8a58d494da3c01be13161be021e9cdb96008221d6e16cd0366b3).

### Description of changes
Corrected the documentation string for `updateToLatestImageVersion` in `ManagedComputeEnvironmentProps`. (taken from [IManagedComputeEnvironment](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts#L97-L99))

### Describe any new or updated permissions being added
N/A


### Description of how you validated changes
N/A (simple documentation fix)

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@ashishdhingra ashishdhingra

Labels
@aws-cdk/aws-batch Related to AWS Batch documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
2 participants
@dillon-odonovan @ashishdhingra