feat(pipelines): Expose stack output namespaces in custom `pipelines.Step`s #23110

tobni · 2022-11-27T23:48:43Z

Closes #23000 as per request from #23000 (comment).

In order for custom steps to include CfnOutput in their action configurations, there needed to be a way to access and/or generate the output variable namespaces. ShellStep already had this capability.

This change generalizes the StackOutputReference usages by letting implementors of Step define the StackOutputReferences their step consumes, instead of hardwiring it to ShellStep.

To actually consume the references, the ICodePipelineActionFactory provides a StackOutputsMap that exposes a method to
render StackOutputReferences into their assigned CodePipeline variable names.

All Submissions:

Have you followed the guidelines in our Contributing guide?

Adding new Unconventional Dependencies:

This PR adds new unconventional dependencies following the process described here

New Features

Have you added the new feature to an integration test?
- Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

gitpod-io · 2022-11-27T23:48:48Z

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.

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

HBobertz

Seems like a pretty simple feature to me, and looks like it's working as intended. In my opinion this feels like quite a lot of effort for not an immense payoff compared to the workaround. As I am new on the team I am going to run this by another engineer before approving

rix0rrr

Love this change! I'd like you to change a couple of small things, but overall thanks for generalizing this feature. Approved if you address my comments.

(Please do write a description of the motivation, the change and significant decisions made in the PR body though! Linking to the issue is not sufficient to cover the last 2 parts.)

packages/@aws-cdk/pipelines/lib/codepipeline/stack-outputs-map.ts

packages/@aws-cdk/pipelines/lib/blueprint/shell-step.ts

rix0rrr · 2022-11-30T09:00:51Z

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

+      actionName: options.actionName,
+      runOrder: options.runOrder,
+      // Map the reference to the variable name the CDK has generated for you.
+      userParameters: {stackOutput: options.stackOutputsMap.mapOutputReference(this.stackOutputReference)},


This shouldn't compile, since stackOutputsMap is optional (should require a ?. or !.), but I'm pretty sure our code translator would balk at that.

Since ProduceActionOptions is much more of an output struct than an input struct, you have my permission to make the field required and silence the backwards compatibility checker.

I've added the compat error to 5bd7d2c, is that sufficient?

Yes, that is it exactly

packages/@aws-cdk/pipelines/lib/codepipeline/codepipeline-action-factory.ts

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

packages/@aws-cdk/pipelines/lib/helpers-internal/pipeline-graph.ts

mapOutputReference -> toCodePipeline

stackOutputDependencies -> consumedStackOutputs

tobni · 2022-12-01T10:06:18Z

Love this change! I'd like you to change a couple of small things, but overall thanks for generalizing this feature. Approved if you address my comments.

(Please do write a description of the motivation, the change and significant decisions made in the PR body though! Linking to the issue is not sufficient to cover the last 2 parts.)

I've addressed the comments (unsure if the compat check is correctly handled) and updated the PR description now.

mergify · 2022-12-01T15:26:55Z

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

tobni · 2022-12-02T08:56:25Z

@rix0rrr I don't understand the Mergify error https://github.com/aws/aws-cdk/runs/9825660539, is there some configuration/permission missing in my fork, or is it permissions in this repo that is sad?

…-in-custom-steps

Pull request has been modified.

aws-cdk-automation · 2022-12-13T00:09:57Z

This PR cannot be merged because it has conflicts. Please resolve them. The PR will be considered stale and closed if it remains in an unmergeable state.

…custom-steps

Pull request has been modified.

aws-cdk-automation · 2023-01-05T15:07:51Z

AWS CodeBuild CI Report

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

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

github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Nov 27, 2022

aws-cdk-automation requested a review from a team November 27, 2022 23:48

github-actions bot added the p2 label Nov 27, 2022

tobni force-pushed the pipelines/enable-stack-output-namespaces-in-custom-steps branch from 43bed9c to 9ec69ac Compare November 27, 2022 23:50

aws-cdk-automation previously requested changes Nov 27, 2022

View reviewed changes

tobni added 4 commits November 28, 2022 02:04

feat: Expose stack output dependencies on Step

6d7e7bc

feat: Let users access stack output variables

f169f63

doc: Fix typo

4c78851

doc: Add example using StackOutputReference

fd37e4e

tobni force-pushed the pipelines/enable-stack-output-namespaces-in-custom-steps branch from 9ec69ac to fd37e4e Compare November 28, 2022 01:04

test: Add integration test

cee8a46

HBobertz reviewed Nov 29, 2022

View reviewed changes

rix0rrr reviewed Nov 30, 2022

View reviewed changes

tobni added 5 commits December 1, 2022 10:27

feat: Make stackOutputsMap non-optional

6f93869

chore: Add breaking changes exception

5bd7d2c

feat: Rename public method

3dc5815

mapOutputReference -> toCodePipeline

feat: Rename public proprerty

394a09b

stackOutputDependencies -> consumedStackOutputs

style: Add missing semicolon

b238b26

tobni force-pushed the pipelines/enable-stack-output-namespaces-in-custom-steps branch from 8c30b18 to b238b26 Compare December 1, 2022 10:02

tobni requested a review from rix0rrr December 1, 2022 14:41

Update allowed-breaking-changes.txt

7097022

rix0rrr previously approved these changes Dec 1, 2022

View reviewed changes

Merge branch 'aws:main' into pipelines/enable-stack-output-namespaces…

7668fdd

…-in-custom-steps

tobni requested a review from rix0rrr December 5, 2022 10:24

Merge branch 'main' into pipelines/enable-stack-output-namespaces-in-…

7097406

…custom-steps

rix0rrr enabled auto-merge (squash) January 5, 2023 14:29

Merge branch 'main' into pipelines/enable-stack-output-namespaces-in-…

34eb6ce

…custom-steps

rix0rrr previously approved these changes Jan 5, 2023

View reviewed changes

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. labels Jan 5, 2023

rix0rrr approved these changes Jan 5, 2023

View reviewed changes

rix0rrr merged commit 14f6811 into aws:main Jan 5, 2023

tobni deleted the pipelines/enable-stack-output-namespaces-in-custom-steps branch January 11, 2023 13:48

filletofish mentioned this pull request Jul 2, 2023

feat(scheduler): ScheduleGroup #26196

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(pipelines): Expose stack output namespaces in custom `pipelines.Step`s #23110

feat(pipelines): Expose stack output namespaces in custom `pipelines.Step`s #23110

tobni commented Nov 27, 2022 •

edited by rix0rrr

Loading

gitpod-io bot commented Nov 27, 2022

aws-cdk-automation left a comment

HBobertz left a comment •

edited

Loading

rix0rrr left a comment

rix0rrr Nov 30, 2022

tobni Dec 1, 2022

rix0rrr Dec 1, 2022

tobni commented Dec 1, 2022

mergify bot commented Dec 1, 2022

tobni commented Dec 2, 2022 •

edited

Loading

aws-cdk-automation commented Dec 13, 2022

aws-cdk-automation commented Jan 5, 2023

feat(pipelines): Expose stack output namespaces in custom pipelines.Steps #23110

feat(pipelines): Expose stack output namespaces in custom pipelines.Steps #23110

Conversation

tobni commented Nov 27, 2022 • edited by rix0rrr Loading

All Submissions:

Adding new Unconventional Dependencies:

New Features

gitpod-io bot commented Nov 27, 2022

aws-cdk-automation left a comment

Choose a reason for hiding this comment

HBobertz left a comment • edited Loading

Choose a reason for hiding this comment

rix0rrr left a comment

Choose a reason for hiding this comment

rix0rrr Nov 30, 2022

Choose a reason for hiding this comment

tobni Dec 1, 2022

Choose a reason for hiding this comment

rix0rrr Dec 1, 2022

Choose a reason for hiding this comment

tobni commented Dec 1, 2022

mergify bot commented Dec 1, 2022

tobni commented Dec 2, 2022 • edited Loading

aws-cdk-automation commented Dec 13, 2022

aws-cdk-automation commented Jan 5, 2023

AWS CodeBuild CI Report

feat(pipelines): Expose stack output namespaces in custom `pipelines.Step`s #23110

feat(pipelines): Expose stack output namespaces in custom `pipelines.Step`s #23110

tobni commented Nov 27, 2022 •

edited by rix0rrr

Loading

HBobertz left a comment •

edited

Loading

tobni commented Dec 2, 2022 •

edited

Loading