feat(codepipeline-actions): support commands action by go-to-k · Pull Request #31667 · aws/aws-cdk

go-to-k · 2024-10-05T17:19:21Z

Issue # (if applicable)

Closes #31666.

Reason for this change

AWS CodePipeline introduces new general purpose compute action: Commands action.

CFn docs:

Description of changes

Added CommandsAction class and changed other files.

The ActionCategory for this action is a new category Compute, so added ActionCategory.COMPUTE.

Description of how you validated changes

Both unit and integ tests

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

add module code

aws-cdk-automation

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.

go-to-k · 2024-10-05T17:32:32Z

packages/aws-cdk-lib/aws-codepipeline/lib/action.ts

  APPROVAL = 'Approval',
  DEPLOY = 'Deploy',
  INVOKE = 'Invoke',
+  COMPUTE = 'Compute',


ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiontypeid.html

go-to-k · 2024-10-05T17:33:50Z

packages/aws-cdk-lib/aws-codepipeline-actions/lib/commands/commands-action.ts

+        // To put the logs in the log group
+        // see: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-Commands.html#action-reference-Commands-policy
+        'logs:CreateLogGroup',
+        'logs:CreateLogStream',
+        'logs:PutLogEvents',


ref: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-Commands.html#action-reference-Commands-policy

go-to-k · 2024-10-05T17:34:01Z

packages/aws-cdk-lib/aws-codepipeline-actions/lib/commands/commands-action.ts

+        // To view the logs in the Commands action on the CodePipeline console
+        // see: https://docs.aws.amazon.com/codepipeline/latest/userguide/security-iam-permissions-console-logs.html
+        'logs:GetLogEvents',


ref: https://docs.aws.amazon.com/codepipeline/latest/userguide/security-iam-permissions-console-logs.html

go-to-k · 2024-10-05T17:37:18Z

packages/aws-cdk-lib/aws-codepipeline/lib/action.ts

+
+  /**
+   * Shell commands for the Commands action to run.
+   *
+   * @default - no commands
+   */
+  readonly commands?: string[];
+
+  /**
+   * The names of the variables in your environment that you want to export.
+   *
+   * @default - no output variables
+   */
+  readonly outputVariables?: string[];


ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-actiondeclaration.html

go-to-k · 2024-10-05T17:38:01Z

packages/aws-cdk-lib/aws-codepipeline/lib/artifact.ts

+   * @param files file paths that you want to export as output artifacts for the action. (can only be used in artifacts for `CommandAction`)
   */
-  public static artifact(name: string): Artifact {
-    return new Artifact(name);
+  public static artifact(name: string, files?: string[]): Artifact {
+    return new Artifact(name, files);


ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-outputartifact.html

go-to-k · 2024-10-05T17:47:36Z

The CodeBuild run under the CommandsAction. But I don't automatically add the permissions for source services with CODEBUILD_CLONE_REF (codeBuildCloneOutput=true).

https://github.com/aws/aws-cdk/blob/v2.161.0/packages/aws-cdk-lib/aws-codepipeline-actions/lib/codebuild/build-action.ts#L189-L211

https://github.com/aws/aws-cdk/blob/v2.161.0/packages/aws-cdk-lib/aws-codepipeline-actions/lib/codestar-connections/source-action.ts#L158-L159

Because an error occurred in the CommandsAction with CODEBUILD_CLONE_REF.

…ion-commands

GavinZZ

Thank you as always for the contribution! Just curious on the design decision.

GavinZZ · 2025-02-06T22:00:44Z

packages/aws-cdk-lib/aws-codepipeline-actions/lib/commands/commands-action.ts

+      provider: 'Commands',
+      artifactBounds: { minInputs: 1, maxInputs: 10, minOutputs: 0, maxOutputs: 1 },
+      inputs: [props.input, ...props.extraInputs || []],
+      outputs: props.output ? [props.output] : [],


since CFN L1 resource can take a list of items as outputs, I'm curious on the design decision on output being one item instead of a list of artifacts?

The number of output artifacts can only be 0 to 1 on the Commands action.

Output artifacts
Number of artifacts: 0 to 1

https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-Commands.html#action-reference-Commands-output

So I made it output as an optional param that can be 0 to 1.

Various actions including the commands action use the same CFn type, so it seems the CFn needs to get an array type.

packages/aws-cdk-lib/aws-codepipeline-actions/lib/commands/commands-action.ts

go-to-k

@GavinZZ

Thanks for your review! I have replied and hope you take a look at it.

go-to-k · 2025-02-07T03:06:28Z

packages/aws-cdk-lib/aws-codepipeline-actions/lib/commands/commands-action.ts

+      provider: 'Commands',
+      artifactBounds: { minInputs: 1, maxInputs: 10, minOutputs: 0, maxOutputs: 1 },
+      inputs: [props.input, ...props.extraInputs || []],
+      outputs: props.output ? [props.output] : [],


The number of output artifacts can only be 0 to 1 on the Commands action.

Output artifacts
Number of artifacts: 0 to 1

https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-Commands.html#action-reference-Commands-output

So I made it output as an optional param that can be 0 to 1.

Various actions including the commands action use the same CFn type, so it seems the CFn needs to get an array type.

packages/aws-cdk-lib/aws-codepipeline-actions/lib/commands/commands-action.ts

Pull request has been modified.

codecov · 2025-02-07T04:17:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.83%. Comparing base (873233b) to head (bfaa773).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #31667   +/-   ##
=======================================
  Coverage   80.83%   80.83%           
=======================================
  Files         236      236           
  Lines       14251    14251           
  Branches     2490     2490           
=======================================
  Hits        11520    11520           
  Misses       2446     2446           
  Partials      285      285

Flag	Coverage Δ
suite.unit	`80.83% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`79.56% <ø> (ø)`
packages/aws-cdk-lib/core	`82.20% <ø> (ø)`

go-to-k · 2025-02-07T07:57:33Z

@GavinZZ

I am not sure if the document has changed since I saw it or if I was mistaken, but I have changed the policies to match the document.

8b8c5d7

ref-1: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-Commands.html#action-reference-Commands-policy

ref-2: https://docs.aws.amazon.com/codepipeline/latest/userguide/security-iam-permissions-console-logs.html

Also, the integ test was slightly modified.

aws-cdk-automation

(This review is outdated)

go-to-k · 2025-02-07T09:52:52Z

~~I'm investigating the CI failure because it creates differences in snapshots.~~

It seems to have been fixed after full build with the latest commit in main branch, soI will run CI again.

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

go-to-k · 2025-02-07T12:08:21Z

@GavinZZ
CI has succeeded.
Could you please check it again?

mergify · 2025-02-07T19:43:36Z

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).

aws-cdk-automation · 2025-02-07T20:15:19Z

AWS CodeBuild CI Report

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

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

mergify · 2025-02-07T20:15:40Z

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).

github-actions · 2025-02-07T20:15:59Z

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.

feat(codepipeline-actions): support Commands action

668b675

add module code

github-actions bot added feature-request A feature should be added or improved. p2 labels Oct 5, 2024

aws-cdk-automation requested a review from a team October 5, 2024 17:19

github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Oct 5, 2024

aws-cdk-automation previously requested changes Oct 5, 2024

View reviewed changes

go-to-k commented Oct 5, 2024

View reviewed changes

go-to-k added 12 commits October 6, 2024 02:51

typo

992ca86

typo

f4a3ad8

path for S3 in integ tests

fc37844

docs

abfa49e

output comments

ad3b118

doc for outputVariables

b12ba83

doc for variable

f593204

Update commands-action.ts

01d3c1b

Update commands-action.ts

f810819

Update commands-action.ts

11e5225

docs

16304a6

validation for variable

a68feff

github-actions bot added the effort/medium Medium work item – several days of effort label Oct 6, 2024

go-to-k changed the title ~~feat(codepipeline-actions): support Commands action~~ feat(codepipeline-actions): support commands action Oct 6, 2024

go-to-k added 8 commits October 18, 2024 18:46

Merge branch 'main' of https://github.com/go-to-k/aws-cdk into cp-act…

4064f47

…ion-commands

wip integ

5f095f5

iam

1c319dc

tweak

d5e4f19

integ

5db973b

versioned in integ

98770d0

zip

21652ba

snapshots

b13bbc0

github-actions bot mentioned this pull request Nov 1, 2024

Monthly PR metrics report #31972

Closed

GavinZZ previously requested changes Feb 6, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 6, 2025

go-to-k commented Feb 7, 2025

View reviewed changes

Merge branch 'main' into cp-action-commands

8995a9f

go-to-k added 2 commits February 7, 2025 16:53

change logs policies

8b8c5d7

change integ

c2e417e

go-to-k added 3 commits February 7, 2025 17:32

fix unit tests

b8f5a8c

snapshots

080b073

rm snapshots

6b82e0a

aws-cdk-automation previously requested changes Feb 7, 2025

View reviewed changes

snapshots

bb58063

upgrade cdk and update snapshots

73875e5

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 7, 2025

go-to-k requested a review from GavinZZ February 7, 2025 12:09

GavinZZ approved these changes Feb 7, 2025

View reviewed changes

Merge branch 'main' into cp-action-commands

bfaa773

mergify bot merged commit 2637d46 into aws:main Feb 7, 2025
18 of 19 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Feb 7, 2025

go-to-k deleted the cp-action-commands branch February 8, 2025 00:02

Conversation

go-to-k commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

go-to-k commented Oct 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GavinZZ left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

go-to-k commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

go-to-k commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

go-to-k commented Feb 7, 2025

Uh oh!

mergify bot commented Feb 7, 2025

Uh oh!

aws-cdk-automation commented Feb 7, 2025

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Feb 7, 2025

Uh oh!

Uh oh!

github-actions bot commented Feb 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

go-to-k commented Oct 5, 2024 •

edited

Loading

go-to-k commented Oct 5, 2024 •

edited

Loading

codecov bot commented Feb 7, 2025 •

edited

Loading

go-to-k commented Feb 7, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

go-to-k commented Feb 7, 2025 •

edited

Loading