From df334a976f2c265b8ecd84f0b087d65baf02cc87 Mon Sep 17 00:00:00 2001 From: Nara Kasbergen Kwon <855115+xiehan@users.noreply.github.com> Date: Fri, 24 Nov 2023 17:35:19 +0100 Subject: [PATCH] chore: add disclaimer to README (#167) Signed-off-by: team-tf-cdk Co-authored-by: team-tf-cdk --- API.md | 17 +++++++++++++++++ README.md | 17 +++++++++++++++++ scripts/update-cdktf.sh | 3 +++ 3 files changed, 37 insertions(+) diff --git a/API.md b/API.md index 40c4a61..57ac03b 100644 --- a/API.md +++ b/API.md @@ -1,7 +1,24 @@ # cdktf-multi-stack-tfe +![Status: Tech Preview](https://img.shields.io/badge/status-experimental-EAAA32) [![Releases](https://img.shields.io/github/release/cdktf/cdktf-multi-stack-tfe.svg)](https://github.com/cdktf/cdktf-multi-stack-tfe/releases) +[![LICENSE](https://img.shields.io/github/license/cdktf/cdktf-multi-stack-tfe.svg)](https://github.com/cdktf/cdktf-multi-stack-tfe/blob/main/LICENSE) +[![build](https://github.com/cdktf/cdktf-multi-stack-tfe/actions/workflows/build.yml/badge.svg)](https://github.com/cdktf/cdktf-multi-stack-tfe/actions/workflows/build.yml) + Setting up Terraform Cloud / Terraform Enterprise workspaces can be tiring when dealing with CDK for Terraform applications spanning multiple stacks and therefore workspaces. This library aims to automate this. +_cdktf-multi-stack-tfe_ is in technical preview, which means it's a community supported project. It still requires extensive testing and polishing to mature into a HashiCorp officially supported project. Please [file issues](https://github.com/cdktf/cdktf-multi-stack-tfe/issues/new/choose) generously and detail your experience while using the library. We welcome your feedback. + +By using the software in this repository, you acknowledge that: +* _cdktf-multi-stack-tfe_ is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp. +* _cdktf-multi-stack-tfe_ is provided on an "as-is" basis, and may include bugs, errors, or other issues. +* _cdktf-multi-stack-tfe_ is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of _cdktf-multi-stack-tfe_. +* HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of _cdktf-multi-stack-tfe_, at any time and without any obligation or liability whatsoever. + +## Compatibility + +- `cdktf` >= 0.19.0 +- `constructs` >= 10.0.107 + ## Usage You need to create the initial workspace yourself, in this case `my-app-base`. diff --git a/README.md b/README.md index bf63f76..5dccbf9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ # cdktf-multi-stack-tfe +![Status: Tech Preview](https://img.shields.io/badge/status-experimental-EAAA32) [![Releases](https://img.shields.io/github/release/cdktf/cdktf-multi-stack-tfe.svg)](https://github.com/cdktf/cdktf-multi-stack-tfe/releases) +[![LICENSE](https://img.shields.io/github/license/cdktf/cdktf-multi-stack-tfe.svg)](https://github.com/cdktf/cdktf-multi-stack-tfe/blob/main/LICENSE) +[![build](https://github.com/cdktf/cdktf-multi-stack-tfe/actions/workflows/build.yml/badge.svg)](https://github.com/cdktf/cdktf-multi-stack-tfe/actions/workflows/build.yml) + Setting up Terraform Cloud / Terraform Enterprise workspaces can be tiring when dealing with CDK for Terraform applications spanning multiple stacks and therefore workspaces. This library aims to automate this. +_cdktf-multi-stack-tfe_ is in technical preview, which means it's a community supported project. It still requires extensive testing and polishing to mature into a HashiCorp officially supported project. Please [file issues](https://github.com/cdktf/cdktf-multi-stack-tfe/issues/new/choose) generously and detail your experience while using the library. We welcome your feedback. + +By using the software in this repository, you acknowledge that: +* _cdktf-multi-stack-tfe_ is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp. +* _cdktf-multi-stack-tfe_ is provided on an "as-is" basis, and may include bugs, errors, or other issues. +* _cdktf-multi-stack-tfe_ is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of _cdktf-multi-stack-tfe_. +* HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of _cdktf-multi-stack-tfe_, at any time and without any obligation or liability whatsoever. + +## Compatibility + +- `cdktf` >= 0.19.0 +- `constructs` >= 10.0.107 + ## Usage You need to create the initial workspace yourself, in this case `my-app-base`. diff --git a/scripts/update-cdktf.sh b/scripts/update-cdktf.sh index ebcdbfb..7de9232 100755 --- a/scripts/update-cdktf.sh +++ b/scripts/update-cdktf.sh @@ -16,3 +16,6 @@ echo "Updating to cdktf version $CDKTF_VERSION" yarn sed -i "s/const cdktfVersion = \".*\";/const cdktfVersion = \">=$CDKTF_VERSION\";/" "$PROJECT_ROOT/.projenrc.ts" CI=0 npx projen + +echo "Updating README" +sed -i 's/`cdktf` >= .*/`cdktf` >= '"$CDKTF_VERSION"'/' "$PROJECT_ROOT/README.md"