Skip to content

Commit

Permalink
chore(release): update docs for 3.0.0 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
aps831 committed May 9, 2023
1 parent 920ca1b commit 1b359e5
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## [](https://github.com/aps831/terraform-bucket/compare/v3.0.0...v) (2023-05-09)

## [3.0.0](https://github.com/aps831/terraform-bucket/compare/v2.0.0...v3.0.0) (2023-05-09)


### ⚠ BREAKING CHANGES

* There is no longer a project parameter

### Features

* use gcp project name for bucket ([920ca1b](https://github.com/aps831/terraform-bucket/commit/920ca1bb91a34bc23ef70e888713a1abd7dfd8a1))

## [2.0.0](https://github.com/aps831/terraform-bucket/compare/fe0a958b8f81db5fbcd911423936fbfb5730216e...v2.0.0) (2023-01-06)


### Features

* add terraform admin role ([fe0a958](https://github.com/aps831/terraform-bucket/commit/fe0a958b8f81db5fbcd911423936fbfb5730216e))

12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This repository provides scripts for bootstrapping buckets (and in the case of G
To initialise an AWS bucket use:

```bash
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/2.0.0/aws-init.sh | bash -s -- --account ${account} --project ${project} --profile ${profile} --region ${region} --tag ${tag}
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/3.0.0/aws-init.sh | bash -s -- --account ${account} --project ${project} --profile ${profile} --region ${region} --tag ${tag}
```

where
Expand All @@ -23,7 +23,7 @@ Note that the S3 bucket with name `${account}-${project}-terraform-state` must b
To cleanup an AWS bucket use:

```bash
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/2.0.0/aws-cleanup.sh | bash -s -- --account ${account} --project ${project} --profile ${profile} --region ${region}
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/3.0.0/aws-cleanup.sh | bash -s -- --account ${account} --project ${project} --profile ${profile} --region ${region}
```

where
Expand All @@ -38,29 +38,27 @@ region = AWS region (eg eu-west-2)
To initialise a GCP project and bucket use:

```bash
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/2.0.0/gcp-init.sh | bash -s -- --account ${account} --project ${project} --gcpproject ${gcpproject} --region ${region}
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/3.0.0/gcp-init.sh | bash -s -- --account ${account} --gcpproject ${gcpproject} --region ${region}
```

where

```text
account = GCP account email address
project = project name (eg git repo plus random word)
gcpproject = GCP project name
region = GCP region (eg europe-west2)
```

Note that `gcpproject` and the storage bucket with name `${project}-terraform-state` must be globally unique.
Note that `gcpproject` and the storage bucket with name `${gcpproject}-terraform-state` must be globally unique.

To cleanup a GCP project and bucket use:

```bash
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/2.0.0/gcp-cleanup.sh | bash -s -- --project ${project} --gcpproject ${gcpproject}
curl -L https://raw.githubusercontent.com/aps831/terraform-bucket/3.0.0/gcp-cleanup.sh | bash -s -- --gcpproject ${gcpproject}
```

where

```text
project = project name (eg git repo plus random word)
gcpproject = GCP project name
```

0 comments on commit 1b359e5

Please sign in to comment.