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

CDK Pipeline: URL for review in Manual Approval #32809

Open
2 tasks
pitayapj opened this issue Jan 9, 2025 · 3 comments
Open
2 tasks

CDK Pipeline: URL for review in Manual Approval #32809

pitayapj opened this issue Jan 9, 2025 · 3 comments
Labels
@aws-cdk/pipelines CDK Pipelines library effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2

Comments

@pitayapj
Copy link

pitayapj commented Jan 9, 2025

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

@pitayapj pitayapj added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jan 9, 2025
@github-actions github-actions bot added the @aws-cdk/pipelines CDK Pipelines library label Jan 9, 2025
@khushail khushail self-assigned this Jan 9, 2025
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. p2 and removed needs-triage This issue or PR still needs to be triaged. labels Jan 9, 2025
@khushail
Copy link
Contributor

khushail commented Jan 9, 2025

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 ?

@khushail khushail added response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Jan 9, 2025
@pitayapj
Copy link
Author

pitayapj commented Jan 9, 2025

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
Copy link
Contributor

khushail commented Jan 9, 2025

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.

@khushail khushail added effort/small Small work item – less than a day of effort effort/medium Medium work item – several days of effort and removed response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. effort/medium Medium work item – several days of effort labels Jan 9, 2025
@khushail khushail removed their assignment Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/pipelines CDK Pipelines library effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

No branches or pull requests

2 participants