Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aws-cloudformation/cfn-language-discussion

Language discussions for CloudFormation template language
https://github.com/aws-cloudformation/cfn-language-discussion

aws cloudformation cloudformation-template infrastructure-as-code

Last synced: about 1 month ago
JSON representation

Language discussions for CloudFormation template language

Awesome Lists containing this project

README 

        
# CFN Language Discussion



## What is it?

This repo is a place to propose and discuss new language features for the CloudFormation template language. It is also a great place to request CloudFormation template language features, report CloudFormation template language bugs or any general discussion related to the CloudFormation template language.



Go to: [What is an RFC](#what-is-an-rfc) | [RFC Process](#rfc-process)



\#|Title|Owner|Status|

---|-----|-----|------|

[43](https://github.com/aws-cloudformation/cfn-language-discussion/issues/43),[73](https://github.com/aws-cloudformation/cfn-language-discussion/issues/73),[79](https://github.com/aws-cloudformation/cfn-language-discussion/issues/79)|[Fn::FindInMap enhancements (default value and intrinsic fns)](https://github.com/aws-cloudformation/cfn-language-discussion/pull/91)|[@mingxingong](https://github.com/mingxingong)|✅ done ([docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap-enhancements.html))

[80](https://github.com/aws-cloudformation/cfn-language-discussion/issues/80)|[Add RFC for Fn::NumberComparison](https://github.com/aws-cloudformation/cfn-language-discussion/pull/90)|[@mingxingong](https://github.com/mingxingong)|✍️ review

[9](https://github.com/aws-cloudformation/cfn-language-discussion/issues/9)|[Adding looping functionality in CFN Template](https://github.com/aws-cloudformation/cfn-language-discussion/pull/75)|[@arthurboghossian](https://github.com/arthurboghossian)|✅ done ([docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-foreach.html))

[14](https://github.com/aws-cloudformation/cfn-language-discussion/issues/14)|[Convert Template Block to JSON String](https://github.com/aws-cloudformation/cfn-language-discussion/pull/76)|[@mluk-aws](https://github.com/mluk-aws)|✅ done ([docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html))

[11](https://github.com/aws-cloudformation/cfn-language-discussion/issues/11)|[Allow Intrinsic Functions and Pseudo-Parameter References in DeletionPolicy and UpdateReplacePolicy](https://github.com/aws-cloudformation/cfn-language-discussion/pull/74)|[@MalikAtalla-AWS](https://github.com/MalikAtalla-AWS)|✅ done ([docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/function-refs-in-policy-attributes.html))

[70](https://github.com/aws-cloudformation/cfn-language-discussion/issues/70)|[Adding Fn::Length support in CFN Template](https://github.com/aws-cloudformation/cfn-language-discussion/pull/72)|[@juegong2](https://github.com/juegong2)|✅ done ([docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-length.html))



## What is an RFC?



An RFC (request for comment) is a text document proposing a change to the CloudFormation template language. RFCs will only contain customer-facing syntax and behavior, not implementation details, and while we welcome all customer feedback on the proposal, the CloudFormation team will have final authority on decisions around the proposal.



### Who should submit an RFC?



In general, anyone can submit RFCs, but it can be a time-consuming process, so we recommend that the community submit [feature requests](https://github.com/aws-cloudformation/cfn-language-discussion/issues/new?assignees=&labels=&template=feature_request.md&title=) to discuss the proposal at a high level. The CloudFormation team can then gather all the community feedback in feature requests to formulate the RFCs.



## RFC Process



### 1. Tracking issue



Each RFC starts with a [tracking issue](https://github.com/aws-cloudformation/cfn-language-discussion/issues/new?assignees=&labels=&template=rfc-tracking-issue.md&title=). This issue is the hub for conversation, community signal (+1s) and a unique identifier for the RFC. CloudFormation team members will comment on the issue to help clarify problems, stabilize syntax and make sure no breaking changes are introduced. The goal of this discussion is to make sure there is no major disagreement on the high-level proposal.



> Before creating any issue, please make sure there are no similar issues in the issue list or RFCs in the RFC table.



The tracking issue includes a checklist which helps the RFC owner drive the RFC

throughout the process.



### 2. RFC Document



Now you can start drafting the RFC document itself.



Create a file under `RFCs/NNNN-my-feature` based on the template under

`0000-template.md`, where `NNNN` is your tracking issue number and `my-feature`

is descriptive. Follow the template which includes guidance on completing the RFC.



### 3. Feedback



Once you have the initial draft of your RFC ready, please submit it as a pull

request and start collecting feedback. The CloudFormation team will assign two reviewers within 5 business days.



### 4. Sign-off



Before you can merge your RFC, you will need both reviewers to sign off on the RFC.



Once signed off, reviewers will add the `status/approved` label to the RFC pull request.



### 5. Final Comments Period



At this stage, you have reached consensus about the majority concerns/questions

brought up during the review period. This is a period for the broader community to

get a chance to look into this RFC, which usually takes about a week. If no

major concerns are raised, your pull request is ready to be merged.



### 6. Implementation



Once the CloudFormation Language team picks up the RFC and starts implementation, we will update the tracking issue accordingly

- Started implementation (label: `status/implementing`)



### 7. Complete



Once Implementation is complete, the CloudFormation Language team will change the status label to `status/done` and close the tracking issue.



## Report bugs or suggest features in the CloudFormation Template Language



We welcome you to use the GitHub issue tracker to report bugs or suggest features.



When filing an issue, please check existing open or recently closed issues to make sure somebody else hasn't already reported the issue.



Please use the [bug report template](https://github.com/aws-cloudformation/cfn-language-discussion/issues/new?assignees=&labels=&template=bug_report.md&title=) for reporting bugs and the [feature request template](https://github.com/aws-cloudformation/cfn-language-discussion/issues/new?assignees=&labels=&template=feature_request.md&title=) for requesting new features.



## Security



If you discover a potential security issue in this project we ask that you notify AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.



## License



This project is licensed under the Apache-2.0 License.



---



## Credit

AWS CloudFormation Language Improvement RFC process owes its inspiration to [AWS CDK's RFC Process](https://github.com/aws/aws-cdk-rfcs)