Skip to content

CDK Pipeline: URL for review in Manual Approval #32809

Open
@pitayapj

Description

Describe the feature

Hi,
ManualApprovalStepProps in CDK Pipeline only have comment property.
Can you guys add URL for review property ?

Thank you.

Use Case

Nothing directly related to feature request but since there is no diff check implemented in cdk pipeline yet,
I am current creating a website so I can check diff files exported to S3.

And ability to add my website URL in L3 construct would be much appreciated. (The ability are there, just need L3 construct update )

Proposed Solution

No response

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
    This feature might incur a breaking change

CDK version used

2

Environment details (OS name and version, etc.)

Linux

Activity

added
feature-requestA feature should be added or improved.
needs-triageThis issue or PR still needs to be triaged.
on Jan 9, 2025
self-assigned this
on Jan 9, 2025
added
investigatingThis issue is being investigated and/or work is in progress to resolve the issue.
and removed
needs-triageThis issue or PR still needs to be triaged.
on Jan 9, 2025
khushail

khushail commented on Jan 9, 2025

@khushail
Contributor

Hi @pitayapj , thanks for reaching out.

AFAIU, Manual approval means pipeline will be paused waiting for human to resume it.

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.ManualApprovalStep.html

Apologies but I am not really sure I understand why you would want a URL and what URL for review would have ? Could you please help throw some more light here ?

added
response-requestedWaiting on additional info and feedback. Will move to "closing-soon" in 7 days.
and removed
investigatingThis issue is being investigated and/or work is in progress to resolve the issue.
on Jan 9, 2025
pitayapj

pitayapj commented on Jan 9, 2025

@pitayapj
Author

Hi @khushail
Thanks for reply.
Like I said in Use case. Because CDK doesn't have a way to check/ run cdk diff's output yet. (feature request in #12273)
So as a work around, I included diff command in CodebuildSteps manually in multiple pipelines from multiple AWS accounts.
The result will be put in a centralized S3 bucket so I can view it via CloudFront.

That is why I want the URL in my use case, so who ever will manual approve pipeline can click to it to check diff before approving.

URL for review actually is ExternalEntityLink parameter in aws cli, which is already available. Just appreciate if you guys can add it to CDK (if it's not too much trouble, notification ARN too would be awesome)
https://docs.aws.amazon.com/codepipeline/latest/userguide/structure-configuration-examples.html

"configuration": {
  "CustomData": "Comments on the manual approval",
  "ExternalEntityLink": "http://my-url.com",
  "NotificationArn": "arn:aws:sns:us-west-2:12345EXAMPLE:Notification"
}
khushail

khushail commented on Jan 9, 2025

@khushail
Contributor

Thanks @pitayapj for sharing your usecase and the link- https://docs.aws.amazon.com/codepipeline/latest/userguide/structure-configuration-examples.html, referencing sample as well.

This surely sounds useful to have. However I would seek team's input here as if its on their radar for future or something they would like to consider with given scenario.

Marking it as P2 (as its good to have) which means it won't be immediately addressed by the team but would be on their radar and contribution from community are also welcome.

added
effort/smallSmall work item – less than a day of effort
effort/mediumMedium work item – several days of effort
and removed
response-requestedWaiting on additional info and feedback. Will move to "closing-soon" in 7 days.
on Jan 9, 2025

6 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Labels

@aws-cdk/pipelinesCDK Pipelines libraryeffort/smallSmall work item – less than a day of effortfeature-requestA feature should be added or improved.open-for-community-contributionWe are welcoming community contributions for this onep2

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    CDK Pipeline: URL for review in Manual Approval Β· Issue #32809 Β· aws/aws-cdk