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.

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

chore: updates container-definition user jsdoc #26231

Merged
merged 3 commits into from
Jul 5, 2023

Conversation

MichaelLeeHobbs
Copy link
Contributor

Update JSDOC for user to clarify that this is a user string and not restricted to a user name.

Reason for this change: When viewing the documentation from an IDE it is unclear that something other than a user name can be used for example 100:101 ie UID and GID.

I have not fully read the following:

This commit/pull request only changes JSDoc.

Closes #26230


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

Update JSDOC for `user` to make it clear that this is a `user string` and not restricted to a user name.
@gitpod-io
Copy link

gitpod-io bot commented Jul 4, 2023

@github-actions github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Jul 4, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team July 4, 2023 18:21
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@MichaelLeeHobbs MichaelLeeHobbs changed the title Update container-definition.ts docs: updates container-definition user prop description Jul 5, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review July 5, 2023 12:40

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@mrgrain mrgrain changed the title docs: updates container-definition user prop description chore: updates container-definition user jsdoc Jul 5, 2023
mrgrain
mrgrain previously approved these changes Jul 5, 2023
@mrgrain
Copy link
Contributor

mrgrain commented Jul 5, 2023

aws-cdk-lib: /codebuild/output/src1382825181/src/github.com/aws/aws-cdk/packages/aws-cdk-lib/aws-ecs/lib/container-definition.ts
aws-cdk-lib:   298:5  error  Trailing spaces not allowed  no-trailing-spaces

@mergify mergify bot dismissed mrgrain’s stale review July 5, 2023 13:06

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: e3762ec
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 5, 2023
@mergify
Copy link
Contributor

mergify bot commented Jul 5, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 3a1837a into aws:main Jul 5, 2023
@MichaelLeeHobbs MichaelLeeHobbs deleted the patch-1 branch July 5, 2023 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
3 participants