Skip to content

chore(tools): update README for spec2cdk with an example#31935

Merged
mergify[bot] merged 4 commits intoaws:mainfrom
iph:patch-1
Oct 30, 2024
Merged

chore(tools): update README for spec2cdk with an example#31935
mergify[bot] merged 4 commits intoaws:mainfrom
iph:patch-1

Conversation

@iph
Copy link
Copy Markdown
Contributor

@iph iph commented Oct 29, 2024

Without an example, it feels very difficult to use spec2cdk as you need a --service in order for the tool to pick up the temporary-schemas.

Issue # (if applicable)

Not applicable

Reason for this change

Just a usability clarification.

Description of changes

I've updated only the README

Description of how you validated changes

I read the changes in preview for markdown.

Checklist


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

Without an example, it feels very difficult to use spec2cdk as you need a `--service` in order for the tool to pick up the temporary-schemas.
@aws-cdk-automation aws-cdk-automation requested a review from a team October 29, 2024 16:40
@github-actions github-actions bot added p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK labels Oct 29, 2024
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.

Co-authored-by: Neta Nir <neta1nir@gmail.com>
@iph iph changed the title chore(tools): Update README for spec2cdk with an example chore(tools): update README for spec2cdk with an example Oct 29, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review October 29, 2024 16:53

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

@mrgrain
Copy link
Copy Markdown
Contributor

mrgrain commented Oct 30, 2024

@mergify update

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 30, 2024

update

✅ Branch has been successfully updated

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 30, 2024

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

@mergify mergify bot merged commit 33a4a5d into aws:main Oct 30, 2024
@github-actions
Copy link
Copy Markdown
Contributor

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants