Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 1.22 KB

Contributing to DNSimple/policy-library-dnsimple-terraform

Getting started

1. Clone the repository

Clone the repository and move into it:

git clone [email protected]:dnsimple/policy-library-dnsimple-terraform.git
cd policy-library-dnsimple-terraform

2. Test

You will require Sentinel (>= 0.23) to run the tests. You can download it from here.

To run a tests for a policy you can use the following command:

make test name="enforce_contact_id.sentinel"

Alternatively, you can run all the tests with:

make tests

Releasing

The following instructions uses $VERSION as a placeholder, where $VERSION is a MAJOR.MINOR.BUGFIX release such as 1.2.0.

  1. Run the test suite and ensure all the tests pass.

  2. Finalize the ## main section in CHANGELOG.md assigning the version.

  3. Commit and push the changes

    git commit -a -m "Release $VERSION"
git push origin main

  4. Wait for CI to complete.

  5. Create a signed tag.

    git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags

  6. Tags are automatically published to the Terraform Policy Registry through webhooks.