From 453c0229eef12edb6d36232ecfea479f5f3a9f95 Mon Sep 17 00:00:00 2001 From: Bryant Biggs Date: Thu, 21 Apr 2022 07:49:41 -0400 Subject: [PATCH] fix: Update documentation to remove prior notice and deprecated workflow (#1) --- .github/workflows/semantic-releaser.yml | 39 ------------------------- README.md | 23 +++++---------- examples/README.md | 8 ++--- examples/appconfig_hosted/README.md | 2 +- examples/s3/README.md | 2 +- examples/ssm_document/README.md | 2 +- examples/ssm_parameter/README.md | 2 +- 7 files changed, 15 insertions(+), 63 deletions(-) delete mode 100644 .github/workflows/semantic-releaser.yml diff --git a/.github/workflows/semantic-releaser.yml b/.github/workflows/semantic-releaser.yml deleted file mode 100644 index 994b434..0000000 --- a/.github/workflows/semantic-releaser.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: release - -on: - workflow_dispatch: - push: - branches: - - main - paths: - - '**.tf' - - '**.tmpl' - - '!examples/**.tf' - - '.github/workflows/semantic-releaser.yml' - -jobs: - release: - name: release - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - with: - fetch-depth: 0 - persist-credentials: false - - - name: Setup Node.js - uses: actions/setup-node@v2 - with: - node-version: 16 - - - name: Release - uses: cycjimmy/semantic-release-action@v2 - with: - semantic_version: 18.0.0 - extra_plugins: | - @semantic-release/changelog@6.0.0 - @semantic-release/git@10.0.0 - conventional-changelog-conventionalcommits@4.6.3 - env: - GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE }} diff --git a/README.md b/README.md index be3fee4..ed44074 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,10 @@ # AWS AppConfig Terraform module -## ⚠️ Module has moved to `terraform-aws-modules` - -This module has moved to the terraform-aws-modules organization. Users will need to update their module source: - -```diff -- source = "clowdhaus/appconfig/aws" -+ source = "terraform-aws-modules/appconfig/aws" -``` - Terraform module which creates AWS AppConfig resources. ## Usage -See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples) directory for working examples to reference: +See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples) directory for working examples to reference: ```hcl module "appconfig" { @@ -74,13 +65,13 @@ module "appconfig" { ## Examples -Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples) are intended +Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples) are intended give users references for how to use the module(s) as well as testing/validating changes to the source code of the module(s). If contributing to the project, please be sure to make any appropriate updates to the relevant examples to allow maintainers to test your changes and to keep the examples up to date for users. Thank you! -- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/appconfig_hosted) -- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/s3) -- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_document) -- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_parameter) +- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/appconfig_hosted) +- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/s3) +- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_document) +- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_parameter) ## Requirements @@ -194,4 +185,4 @@ No modules. ## License -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE). diff --git a/examples/README.md b/examples/README.md index 58b1695..cfbd542 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,6 @@ # Terraform AWS AppConfig examples -- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/appconfig_hosted) -- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/s3) -- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_document) -- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_parameter) +- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/appconfig_hosted) +- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/s3) +- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_document) +- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_parameter) diff --git a/examples/appconfig_hosted/README.md b/examples/appconfig_hosted/README.md index 2b4209b..0aad47a 100644 --- a/examples/appconfig_hosted/README.md +++ b/examples/appconfig_hosted/README.md @@ -80,4 +80,4 @@ No inputs. | [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role | -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE). diff --git a/examples/s3/README.md b/examples/s3/README.md index cbf824a..596cc13 100644 --- a/examples/s3/README.md +++ b/examples/s3/README.md @@ -83,4 +83,4 @@ No inputs. | [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role | -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE). diff --git a/examples/ssm_document/README.md b/examples/ssm_document/README.md index b0ebbbb..c289e98 100644 --- a/examples/ssm_document/README.md +++ b/examples/ssm_document/README.md @@ -76,4 +76,4 @@ No inputs. | [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role | -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE). diff --git a/examples/ssm_parameter/README.md b/examples/ssm_parameter/README.md index 6376194..94d78c7 100644 --- a/examples/ssm_parameter/README.md +++ b/examples/ssm_parameter/README.md @@ -80,4 +80,4 @@ No inputs. | [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role | -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE).