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

aws-cdk-lib/aws-codebuild: Incorrect documentation on LinuxArmBuildImage #31717

Closed
lucacucchetti opened this issue Oct 10, 2024 · 3 comments · Fixed by #31718
Closed

aws-cdk-lib/aws-codebuild: Incorrect documentation on LinuxArmBuildImage #31717

lucacucchetti opened this issue Oct 10, 2024 · 3 comments · Fixed by #31718
Labels
@aws-cdk/aws-codebuild Related to AWS CodeBuild documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@lucacucchetti
Copy link
Contributor

Describe the issue

Hello, I was temporarily thrown off by LinuxArmBuildImage.fromDockerRegistry saying the following (being in a class for aarch64):

Returns: a x86-64 Linux build image from a Docker Hub image.

Source Code.

Links

https://github.com/aws/aws-cdk/blob/c1b240ee6fdba9a0ca1126c97c5e0173bae007ce/packages/aws-cdk-lib/aws-codebuild/lib/linux-arm-build-image.ts#L45C6-L45C23
@lucacucchetti lucacucchetti added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Oct 10, 2024
@khushail khushail added p2 investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Oct 10, 2024
@khushail khushail self-assigned this Oct 10, 2024
@khushail
Copy link
Contributor

Hi @lucacucchetti ,thanks for reaching out.

Yes, I can confirm by looking at the cdk doc for this module as well -

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.LinuxArmBuildImage.html

Screenshot 2024-10-10 at 11 46 36 AM

Yes, this surely needs to be corrected.
Thanks.

@khushail khushail added effort/small Small work item – less than a day of effort @aws-cdk/aws-codebuild Related to AWS CodeBuild and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Oct 10, 2024
@khushail khushail mentioned this issue Oct 10, 2024
Merged
1 task
@khushail khushail removed their assignment Oct 10, 2024
@mergify mergify bot closed this as completed in 048975e Oct 10, 2024
@mergify mergify bot closed this as completed in #31718 Oct 10, 2024
@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.

1 similar comment
@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 Oct 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
@aws-cdk/aws-codebuild Related to AWS CodeBuild 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
Development

Successfully merging a pull request may close this issue.

docs(codebuild): updated Linux build image return type in doc aws/aws-cdk
3 participants
@lucacucchetti @ashishdhingra @khushail