aws / aws/aws-cdk

aws-ecs: `ContainerImage.fromEcrRepository` should be `tagOrDigest`

Open
#30,463 2 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-ecs bug documentation effort/small p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the issue

The underlying `EcrImage` constructor has the correct naming `tagOrDigest` since most use the helper static method the name and documentation should be updated there is as well.

https://github.com/aws/aws-cdk/blob/v2.144.0/packages/aws-cdk-lib/aws-ecs/lib/images/ecr.ts#L22

### Links

https://github.com/aws/aws-cdk/blob/v2.144.0/packages/aws-cdk-lib/aws-ecs/lib/container-image.ts#L22
https://github.com/aws/aws-cdk/blob/v2.144.0/packages/aws-cdk-lib/aws-ecs/lib/images/ecr.ts#L22

Contributor guide

Open the contributing guide

Research direction

Start with packages/aws-cdk-lib/aws-ecs/lib/container-image.ts and packages/aws-cdk-lib/aws-ecs/lib/images/ecr.ts at the linked declarations. Compare the parameter name and documentation in both locations, then update the helper so the naming matches EcrImage; done means the public name and its documentation consistently use tagOrDigest.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.