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

feat(core): Add ability to set stack description (#4457) #4477

Merged
merged 3 commits into from
Oct 11, 2019

Conversation

TomDufall
Copy link
Contributor

Add the ability to set a description for a stack.
Closes #4457

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

@TomDufall TomDufall requested a review from eladb as a code owner October 11, 2019 16:15
@mergify
Copy link
Contributor

mergify bot commented Oct 11, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist
:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

@TomDufall
Copy link
Contributor Author

A few questions to resolve:

  • I'm not sure how docs work - will this be automatically picked up or do I need to add it somewhere?
  • I haven't tried actually making a stack manually since I'm not sure how to do that with a local version of the cdk. If someone more knowledgeable could either do this or verify that I'm definitely testing stack output correctly, that would be great
  • The CloudFormation length limit for the description is listed as 1024 bytes here. A quick Google suggests this'll probably be 512 characters for most uses, so that's what I've tested for. Any clarification or better test method is welcome
  • This is the first TS I've written, so watch out for beginner or convention errors. It compiles locally and passes the linter, though, so should be fine.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify
Copy link
Contributor

mergify bot commented Oct 11, 2019

Thank you for contributing! Your pull request is now being automatically merged.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Add ability to set stack description
3 participants