From 7e39b1758f4d3861f0ea68332df248c7988cf4f0 Mon Sep 17 00:00:00 2001 From: Bryant Biggs Date: Wed, 20 Apr 2022 19:27:56 -0400 Subject: [PATCH] chore: Update documentation to remove prior notice and deprecated workflow --- .github/workflows/semantic-releaser.yml | 39 ------------------------- README.md | 19 ++++-------- examples/README.md | 4 +-- examples/ec2/README.md | 2 +- examples/fargate/README.md | 2 +- 5 files changed, 9 insertions(+), 57 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 25dd213..539c970 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,10 @@ # AWS Batch 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/batch/aws" -+ source = "terraform-aws-modules/batch/aws" -``` - Terraform module which creates AWS Batch resources. ## Usage -See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/main/examples) directory for working examples to reference: +See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/master/examples) directory for working examples to reference: ```hcl module "batch" { @@ -160,10 +151,10 @@ module "batch" { ## Examples -Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/main/examples) are intended to give users references for how to use the module(s) as well as testing/validating changes to the source code of the module. 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! +Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/master/examples) are intended to give users references for how to use the module(s) as well as testing/validating changes to the source code of the module. 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! -- [EC2](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/main/examples/ec2) -- [Fargate](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/main/examples/fargate) +- [EC2](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/master/examples/ec2) +- [Fargate](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/master/examples/fargate) ## Requirements @@ -263,4 +254,4 @@ No modules. ## License -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-batch/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-batch/blob/master/LICENSE). diff --git a/examples/README.md b/examples/README.md index c94b1b7..347111d 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4 +1,4 @@ # Terraform AWS Batch Examples -- [EC2](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/main/examples/ec2) -- [Fargate](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/main/examples/fargate) +- [EC2](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/master/examples/ec2) +- [Fargate](https://github.com/terraform-aws-modules/terraform-aws-batch/tree/master/examples/fargate) diff --git a/examples/ec2/README.md b/examples/ec2/README.md index 65f1fbe..c084e99 100644 --- a/examples/ec2/README.md +++ b/examples/ec2/README.md @@ -77,4 +77,4 @@ No inputs. | [spot\_fleet\_iam\_role\_unique\_id](#output\_spot\_fleet\_iam\_role\_unique\_id) | Stable and unique string identifying the IAM role | -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-batch/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-batch/blob/master/LICENSE). diff --git a/examples/fargate/README.md b/examples/fargate/README.md index 0fe62d4..609217a 100644 --- a/examples/fargate/README.md +++ b/examples/fargate/README.md @@ -79,4 +79,4 @@ No inputs. | [spot\_fleet\_iam\_role\_unique\_id](#output\_spot\_fleet\_iam\_role\_unique\_id) | Stable and unique string identifying the IAM role | -Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-batch/blob/main/LICENSE). +Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-batch/blob/master/LICENSE).