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

refactor(codepipeline): API cleanup #2982

Merged
merged 1 commit into from
Jun 21, 2019

Conversation

skinny85
Copy link
Contributor

BREAKING CHANGE: rename CodeCommitAction.pollForSourceChanges to trigger,
and make it an enum.

  • Change the GitHubTrigger enum to use all caps for member names.
  • Rename S3SourceAction.pollForSourceChanges to trigger,
    and make it an enum.
  • Rename StageAddToPipelineProps interface to AddStageProps.
  • Remove the classes CloudFormationAction and CloudFormationDeployAction.

Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
    • Design: For significant features, design document added to design folder
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

@skinny85 skinny85 requested a review from a team as a code owner June 21, 2019 04:46
@@ -47,7 +47,7 @@ export interface StageProps {
readonly actions?: Action[];
}

export interface StageAddToPipelineProps extends StageProps {
export interface AddStageProps extends StageProps {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be called simply StageOptions

Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename to StageOptions

@skinny85 skinny85 force-pushed the refactor/codepipeline-api-cleanup branch from b402567 to a48ca5a Compare June 21, 2019 18:15
BREAKING CHANGE: rename CodeCommitAction.pollForSourceChanges to trigger,
and make it an enum.
* Rename S3SourceAction.pollForSourceChanges to trigger,
and make it an enum.
* Rename StageAddToPipelineProps interface to AddStageProps.
* Remove the classes CloudFormationAction and CloudFormationDeployAction.
@skinny85 skinny85 force-pushed the refactor/codepipeline-api-cleanup branch from a48ca5a to 5d75e1c Compare June 21, 2019 18:16
@skinny85
Copy link
Contributor Author

Rename to StageOptions

Done.

@skinny85 skinny85 merged commit 13025c4 into aws:master Jun 21, 2019
@skinny85 skinny85 deleted the refactor/codepipeline-api-cleanup branch June 21, 2019 20:48
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants