Skip to content

Commit 901908b

Browse files
author
iru
authored
Update CONTRIBUTE.md (#90)
1 parent cee8f83 commit 901908b

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

CONTRIBUTE.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,17 @@
1616

1717
# Pull Request
1818

19-
> TLDR; Should any pre-merge test fail, check `/.github/workflows/ci-integration-test.yaml` to identify what's required
19+
> TL;DR;<br/>
20+
> Feel free to merge as soon as needed, provided pre-merge checks pass<br/>
21+
> Should any fail, check `/.github/workflows/ci-integration-test.yaml` to identify what's required
2022
2123
## 0. General Guidelines
2224

2325
* Use pull-request **drafts for visibility on WIP branches**
2426
* Unless a revision is desired in order to validate, or gather some feedback, **you are free to merge it as long as**
2527
* validation checkers are all green-lighted
2628
* you've got permissions to do so :)
27-
* Check wether anything else is required for your contribution
29+
* Check whether anything else is required for your contribution
2830

2931
### Contribution checklist
3032

@@ -67,14 +69,15 @@ Implemented vía **Terraform Kitchen** | https://newcontext-oss.github.io/kitche
6769

6870
- Kitchen configuration can be found in `/.kitchen.yml`
6971
- Under `/test/fixtures` you can find the targets that will be tested. Please keep this as similar as possible to the Terraform Registry Modules examples.
72+
- AWS_PROFILE configuration is required to access the [TF s3 state backend](#terraform-backend)
7073

7174
**Running Kitchen tests locally**
7275

7376
Ruby 2.7 is required to launch the tests.
7477
Run `bundle install` to get kitchen-terraform bundle.
7578
Cloud Provider credentials should be configured locally.
7679
```shell
77-
# launch the tests, in other words, it will run `terraform apply`
80+
# launch all the tests, in other words, it will run `terraform apply`
7881
$ bundle exec kitchen converge
7982

8083
# will destroy test infrastructure, in short, it will run `terraform destroy`
@@ -83,6 +86,9 @@ $ bundle exec kitchen destroy
8386
# run all the workflow. In first place, it will run an `apply`. Then, if and only if the `apply` works it will destroy the infrastructure.
8487
$ bundle exec kitchen tests
8588

89+
# run one specific test
90+
$ bundle exec kitchen test "single-account-k8s-aws"
91+
8692
```
8793

8894
### Terraform Backend
@@ -99,8 +105,9 @@ Check project github secrets for clarification
99105

100106
# Release
101107

102-
- Use **semver** for releases https://semver.org
103-
- Module official releases will be published at terraform registry
104-
- Just create a tag/release and it will be fetched by pre-configured webhook and published into.
105-
- For internal usage, TAGs can be used
106-
- For official verions, RELEASEs will be used, with its corresponding changelog description.
108+
Feel free to release as soon as needed.
109+
110+
- Create a tag and it will be fetched by pre-configured webhook.
111+
- use [semver](https://semver.org) notation
112+
- A changelog description will be generated based on [conventional-commints](https://www.conventionalcommits.org/en/v1.0.0/) , but please verify all changes are included and explain acordingly if/when required
113+
- Module official releases will be published at terraform registry automatically

0 commit comments

Comments
 (0)