feat(codepipeline): add construct for registering custom Actions #17041

rayjanwilson · 2021-10-18T15:38:45Z

all it does is add ./common and ./custom-action-registration to the modules index.ts

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

gitpod-io · 2021-10-18T15:38:48Z

skinny85

Thanks for the PR @rayjanwilson, but things are not that simple (aren't they always 😜).

We will need to make some changes to custom-action-registration.ts - the build currently fails with:

@aws-cdk/aws-codepipeline-actions: �[96mlib/custom-action-registration.ts�[0m:�[93m105�[0m:�[93m3�[0m - �[91merror�[0m�[90m JSII3008: �[0mThe "actionProperties" property of struct "@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps" must be "readonly". Rename "@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps" to "ICustomActionRegistrationProps" if it is meant to be a behavioral interface.

We need to make all of the properties of CustomActionProperty readonly. While we're in the area, we'll probably have to make a few more adjustments before we make this a public part of the API of the module (and hence we'll have to maintain it going forwards).

Are you up for that @rayjanwilson? 🙂

Thanks,
Adam

skinny85 · 2021-10-18T22:44:35Z

packages/@aws-cdk/aws-codepipeline-actions/lib/index.ts

@@ -18,3 +18,5 @@ export * from './s3/source-action';
 export * from './stepfunctions/invoke-action';
 export * from './servicecatalog/deploy-action-beta1';
 export * from './action';
+export * from './common';


Why the export of common? Why do you need it?

oh just figured it helped when making custom source actions

Let's leave it out then please 🙂.

Pull request has been modified.

rayjanwilson · 2021-10-19T21:27:40Z

We need to make all of the properties of CustomActionProperty readonly. While we're in the area, we'll probably have to make a few more adjustments before we make this a public part of the API of the module (and hence we'll have to maintain it going forwards).

Are you up for that @rayjanwilson? 🙂

yep happy to give it a go and iterate towards what it should be. first time doing this =)

skinny85 · 2021-10-19T22:16:29Z

We need to make all of the properties of CustomActionProperty readonly. While we're in the area, we'll probably have to make a few more adjustments before we make this a public part of the API of the module (and hence we'll have to maintain it going forwards).
Are you up for that @rayjanwilson? 🙂

yep happy to give it a go and iterate towards what it should be. first time doing this =)

Sweet. Let's start by adding those readonly to the properties, and we'll take it from there 🙂.

rayjanwilson · 2021-10-20T15:25:27Z

removed common and changed CustomActionProperty to be readonly

skinny85 · 2021-10-20T19:14:12Z

@rayjanwilson Now you need to do the same for CustomActionRegistrationProps 😜.

@aws-cdk/aws-codepipeline-actions: �[96mlib/custom-action-registration.ts�[0m:�[93m98�[0m:�[93m3�[0m - �[91merror�[0m�[90m JSII3008: �[0mThe "executionUrl" property of struct "@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps" must be "readonly". Rename "@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps" to "ICustomActionRegistrationProps" if it is meant to be a behavioral interface.

rayjanwilson · 2021-10-20T23:45:54Z

oh, derp. fixed

skinny85 · 2021-10-21T00:36:51Z

Still some errors:

@aws-cdk/aws-codepipeline-actions: error: [awslint:construct-ctor:@aws-cdk/aws-codepipeline-actions.CustomActionRegistration.<initializer>.params[0]] signature of all construct constructors should be "scope, id, props".   (expected="scope",actual="parent")
@aws-cdk/aws-codepipeline-actions: error: [awslint:props-default-doc:@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps.entityUrl] Optional property must have @default documentation 
@aws-cdk/aws-codepipeline-actions: error: [awslint:props-default-doc:@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps.executionUrl] Optional property must have @default documentation 
@aws-cdk/aws-codepipeline-actions: Error: /codebuild/output/src259442693/src/github.com/aws/aws-cdk/tools/@aws-cdk/cdk-build-tools/bin/cdk-awslint exited with error code 1

@rayjanwilson did you go through our "Contributing" guide? You should be able to see these errors when building locally, no need to wait for the PR build 🙂.

rayjanwilson · 2021-10-21T14:10:16Z

i'll go through it again

rayjanwilson · 2021-10-21T15:27:15Z

k, i had to flush all the old docker images and volumes. that was causing the devcontainer to crash when doing the post-create command. it's building now and i'll be able to go through the contributing section correctly now. cheers

skinny85

Looks great @rayjanwilson! Let's add some JSDocs to the fileds, and let's get this merged in!

Would you mind also updating the ReadMe of the module, showing an example of how to use this class?

skinny85 · 2021-10-22T00:06:25Z

packages/@aws-cdk/aws-codepipeline-actions/package.json

@@ -172,7 +172,9 @@
      "docs-public-apis:@aws-cdk/aws-codepipeline-actions.GitHubTrigger.POLL",
      "docs-public-apis:@aws-cdk/aws-codepipeline-actions.GitHubTrigger.WEBHOOK",
      "docs-public-apis:@aws-cdk/aws-codepipeline-actions.CodeDeployEcsDeployAction",
-      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CodeDeployEcsDeployActionProps.containerImageInputs"
+      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CodeDeployEcsDeployActionProps.containerImageInputs",
+      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps.entityUrl",


Instead of adding an exemption here, let's actually fill out this documentation:

/** * The URL shown for the entire Action in the Pipeline UI. * * @default - none */ readonly entityUrl?: string;

skinny85 · 2021-10-22T00:07:25Z

packages/@aws-cdk/aws-codepipeline-actions/package.json

-      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CodeDeployEcsDeployActionProps.containerImageInputs"
+      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CodeDeployEcsDeployActionProps.containerImageInputs",
+      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps.entityUrl",
+      "props-default-doc:@aws-cdk/aws-codepipeline-actions.CustomActionRegistrationProps.executionUrl"


Same here:

/** * The URL shown for a particular execution of an Action in the Pipeline UI. * * @default - none */ readonly executionUrl?: string;

skinny85 · 2021-10-22T00:13:33Z

Actually @rayjanwilson, since you're doing work in this are anyway... Can you please move these classes to the @aws-cdk/aws-codepipeline module? I think they make much more sense there (the ReadMe changes should also be to that module's file).

rayjanwilson · 2021-10-22T13:44:58Z

yes for sure

skinny85 · 2021-10-22T18:05:44Z

Thanks!

skinny85

Putting in "Request changes" to clear this one from my To-Do list. @rayjanwilson please re-request my review when this is ready!

Pull request has been modified.

…the readme

skinny85

Thanks for the effort @rayjanwilson, but, like I mentioned before, let's leave common.ts exactly where it is now, unchanged.

skinny85 · 2021-11-04T01:09:29Z

packages/@aws-cdk/aws-codepipeline/lib/common.ts

@@ -1,10 +1,10 @@
-import * as codepipeline from '@aws-cdk/aws-codepipeline';
+import { ActionArtifactBounds } from './action';

 /**


I thought we resolved this already? 😃

Do not touch this file - leave it where it is, don't move it to the @aws-cdk/aws-codepipeline module, and do not make it public.

we had, my bad. it's what i get for picking back up after a week or so. apologies. reverted

Pull request has been modified.

skinny85

Looks great, thanks @rayjanwilson!

skinny85 · 2021-11-04T21:11:43Z

packages/@aws-cdk/aws-codepipeline/README.md

@@ -109,6 +109,40 @@ or you can use the `IStage.addAction()` method to mutate an existing Stage:
 sourceStage.addAction(someAction);
 ```

+## Custom Action Registration
+
+To make your own custom CodePipeline Action requires registering the action provider. Look to the `JenkinsProvider` in `@aws-cdk/aws-codepipeline-actions` for an implementation example.


Be wary of long lines in this file:

Suggested change

To make your own custom CodePipeline Action requires registering the action provider. Look to the `JenkinsProvider` in `@aws-cdk/aws-codepipeline-actions` for an implementation example.

To make your own custom CodePipeline Action requires registering the action provider.

Look to the `JenkinsProvider` in `@aws-cdk/aws-codepipeline-actions` for an implementation example.

mergify · 2021-11-04T22:06:55Z

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

aws-cdk-automation · 2021-11-04T23:46:36Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: 12d7fb6
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2021-11-04T23:46:42Z

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

…#17041) fixes aws#17039 all it does is add `./common` and `./custom-action-registration` to the modules `index.ts` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

skinny85 previously requested changes Oct 18, 2021

View reviewed changes

peterwoodworth assigned skinny85 Oct 21, 2021

peterwoodworth added the @aws-cdk/aws-codepipeline-actions label Oct 21, 2021

skinny85 suggested changes Oct 22, 2021

View reviewed changes

skinny85 changed the title ~~fix(aws-codepipeline-actions): include missing exports with index.ts~~ fix(codepipeline): add a CustomActionRegistration construct Oct 22, 2021

github-actions bot added the @aws-cdk/aws-codepipeline Related to AWS CodePipeline label Oct 22, 2021

skinny85 changed the title ~~fix(codepipeline): add a CustomActionRegistration construct~~ feat(codepipeline): add a CustomActionRegistration construct Oct 22, 2021

skinny85 previously requested changes Oct 22, 2021

View reviewed changes

rayjanwilson and others added 8 commits October 29, 2021 11:24

exports common and the custom-action-registration

a049ac2

removes common from index.ts

f0518c2

makes the CustomActionProperty readonly

fe63401

adds readonly to CustomActionRegistrationProps

6cdaef7

addresses awslint requirements

37fc790

removes exemptions and adds the documentation

738cf5e

moves classes to aws-codepipeline and updates dependencies

251fdb0

Merge branch 'aws:master' into aws-codepipeline-action-export

cff2ff3

adds custom action registration example with sourceArtifactBounds to …

54305ea

…the readme

rayjanwilson requested a review from skinny85 November 4, 2021 00:55

skinny85 previously requested changes Nov 4, 2021

View reviewed changes

reverts moving common.ts

128e247

skinny85 approved these changes Nov 4, 2021

View reviewed changes

skinny85 changed the title ~~feat(codepipeline): add a CustomActionRegistration construct~~ feat(codepipeline): add construct for registering custom Actions Nov 4, 2021

skinny85 added the pr-linter/exempt-test The PR linter will not require test changes label Nov 4, 2021

Merge branch 'master' into aws-codepipeline-action-export

12d7fb6

mergify bot merged commit c66ac89 into aws:master Nov 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(codepipeline): add construct for registering custom Actions #17041

feat(codepipeline): add construct for registering custom Actions #17041

rayjanwilson commented Oct 18, 2021

gitpod-io bot commented Oct 18, 2021

skinny85 left a comment

skinny85 Oct 18, 2021

rayjanwilson Oct 19, 2021

skinny85 Oct 19, 2021

rayjanwilson commented Oct 19, 2021

skinny85 commented Oct 19, 2021

rayjanwilson commented Oct 20, 2021

skinny85 commented Oct 20, 2021

rayjanwilson commented Oct 20, 2021

skinny85 commented Oct 21, 2021

rayjanwilson commented Oct 21, 2021

rayjanwilson commented Oct 21, 2021

skinny85 left a comment

skinny85 Oct 22, 2021

skinny85 Oct 22, 2021

skinny85 commented Oct 22, 2021

rayjanwilson commented Oct 22, 2021

skinny85 commented Oct 22, 2021

skinny85 left a comment

skinny85 left a comment

skinny85 Nov 4, 2021

rayjanwilson Nov 4, 2021

skinny85 left a comment

skinny85 Nov 4, 2021

mergify bot commented Nov 4, 2021

aws-cdk-automation commented Nov 4, 2021

mergify bot commented Nov 4, 2021

	To make your own custom CodePipeline Action requires registering the action provider. Look to the `JenkinsProvider` in `@aws-cdk/aws-codepipeline-actions` for an implementation example.
	To make your own custom CodePipeline Action requires registering the action provider.
	Look to the `JenkinsProvider` in `@aws-cdk/aws-codepipeline-actions` for an implementation example.

feat(codepipeline): add construct for registering custom Actions #17041

feat(codepipeline): add construct for registering custom Actions #17041

Conversation

rayjanwilson commented Oct 18, 2021

gitpod-io bot commented Oct 18, 2021

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rayjanwilson commented Oct 19, 2021

skinny85 commented Oct 19, 2021

rayjanwilson commented Oct 20, 2021

skinny85 commented Oct 20, 2021

rayjanwilson commented Oct 20, 2021

skinny85 commented Oct 21, 2021

rayjanwilson commented Oct 21, 2021

rayjanwilson commented Oct 21, 2021

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 commented Oct 22, 2021

rayjanwilson commented Oct 22, 2021

skinny85 commented Oct 22, 2021

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mergify bot commented Nov 4, 2021

aws-cdk-automation commented Nov 4, 2021

AWS CodeBuild CI Report

mergify bot commented Nov 4, 2021