Skip to content

docs(stepfunctions): replace definition with definitionBody in readm of aws-stepfunctions#27110

Merged
mergify[bot] merged 2 commits intoaws:mainfrom
ymhiroki:step-functions-readme
Sep 12, 2023
Merged

docs(stepfunctions): replace definition with definitionBody in readm of aws-stepfunctions#27110
mergify[bot] merged 2 commits intoaws:mainfrom
ymhiroki:step-functions-readme

Conversation

@ymhiroki
Copy link
Copy Markdown
Contributor

definition in Construct Props of sfn.StateMachine is already deprecated and definitionBody is recommended.
README and docs still use definition in examples, and it's misleading for users.

I replaced definition with definitionBody and sfn.DefinitionBody.fromChainable(...) in them.


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

@github-actions github-actions bot added the valued-contributor [Pilot] contributed between 6-12 PRs to the CDK label Sep 12, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team September 12, 2023 06:14
@github-actions github-actions bot added the p2 label Sep 12, 2023
Copy link
Copy Markdown
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

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.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@ymhiroki ymhiroki changed the title replace definition with definitionBody in readm of aws-stepfunctions docs(stepfunctions): replace definition with definitionBody in readm of aws-stepfunctions Sep 12, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review September 12, 2023 06:23

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 12, 2023
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 12, 2023

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 12, 2023
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 12, 2023

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

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 0bec9c6
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit c5e0836 into aws:main Sep 12, 2023
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 12, 2023

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

mikewrighton pushed a commit that referenced this pull request Sep 14, 2023
…of aws-stepfunctions (#27110)

`definition` in Construct Props of `sfn.StateMachine` is already deprecated and `definitionBody` is recommended.
README and docs still use `definition` in examples, and it's misleading for users.

I replaced `definition` with `definitionBody` and `sfn.DefinitionBody.fromChainable(...)` in them.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@ymhiroki ymhiroki deleted the step-functions-readme branch November 7, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

p2 valued-contributor [Pilot] contributed between 6-12 PRs to the CDK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants