Skip to content

Commit

Permalink
docs: update readme and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
artis3n committed Oct 1, 2022
1 parent aa7852f commit 4d2b040
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 13 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ When planning a contribution to this repository, please first discuss the change
When generating release notes, the repository owners rely on the following conventional specs:

- `feat:` for new features
- `feat!:` for breaking changes to features
- `fix:` for bug fixes
- `improvement:` for enhancements
- `docs:`: for documentation and examples
Expand Down
13 changes: 2 additions & 11 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The project has the following folders and files:
- `/*.tf`: Terraform files that consitute the executable code within the `digitalocean/github-oidc/vault` Terraform module.
- `/examples`: Relatively plug-and-play examples for using this module.
- `/test`: Folders with files setting up an ephemeral Vault for running [Terratest](https://terratest.gruntwork.io) to test the module (see [Integration Testing](#integration-testing)).
- The `/test/packer` directory builds a weekly Droplet snapshot of a base Vault installation on an Ubuntu server to simplify the regular Terraform invocations during PR reviews.
- The `/test/packer` directory builds a weekly Droplet snapshot of a base Vault installation on an Ubuntu server to simplify + speed up the regular Terraform invocations during PR reviews.
- The `/test/terratest` directory contains the Terratest code executed during pull request reviews.
- `/main.tf`: The main file of the module, containing all of the resources that will be created.
- `/variables.tf`: All of the variables for the module.
Expand Down Expand Up @@ -104,18 +104,9 @@ If you wish to use `act`, install with `brew install act` and run:

```bash
# Check Terraform syntax
act -j fmt-validate -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest
act -j fmt-validate -P ubuntu-22.04=ghcr.io/catthehacker/ubuntu:act-22.04
```

If you want to waste a bunch of hard drive space, you can run the `pre-commit` job through act with:

```bash
# This will take up 40+ GB!
act -j pre-commit -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:full-latest
```

However, running `brew install pre-commit && pre-commit run -a` will be much faster and accomplish the same task.

## Linting and Formatting

The Terraform, Packer, and Go code can be linted and formatted to maintain a standard of quality. Run `make fmt`.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ This is encapsulated by the `oidc_bindings` variable.
> **Note**
>
> v2 of this module adopts Terraform 1.3's standardized support of [optional object type attributes](https://www.terraform.io/language/expressions/type-constraints#optional-object-type-attributes).
> Therefore, Terraform 1.3+ is required to use v2.0.0 or higher of this module.
> Therefore, Terraform 1.3+ is required to use v2.0.0 or higher.
>
> Users of Terraform 1.2 or earlier can use v1.1.0 of this module with the [`module_variable_optional_attrs`](https://www.terraform.io/language/v1.2.x/expressions/type-constraints#experimental-optional-object-type-attributes) experimental feature enabled.
> Users with Terraform 1.2 or earlier can use v1.1.0 of this module with the [`module_variable_optional_attrs`](https://www.terraform.io/language/v1.2.x/expressions/type-constraints#experimental-optional-object-type-attributes) experimental Terraform feature enabled.

## Examples

Expand Down

0 comments on commit 4d2b040

Please sign in to comment.