diff --git a/.copywrite.hcl b/.copywrite.hcl new file mode 100644 index 0000000..9d58339 --- /dev/null +++ b/.copywrite.hcl @@ -0,0 +1,27 @@ +schema_version = 1 + +project { + license = "MPL-2.0" + copyright_year = 2020 + + header_ignore = [ + # changie tooling configuration and CHANGELOG entries (prose) + ".changes/unreleased/*.yaml", + ".changie.yaml", + + # GitHub issue template configuration + ".github/ISSUE_TEMPLATE/*.yml", + + # GitHub Actions workflow-specific configurations + ".github/labeler-*.yml", + + # Github Action linting configuration + ".github/actionlint.yaml", + + # Release Engineering tooling configuration + ".release/*.hcl", + + # Auto-generated /dist + "/dist/**", + ] +} diff --git a/.github/workflows/compliance.yml b/.github/workflows/compliance.yml new file mode 100644 index 0000000..ae03ab6 --- /dev/null +++ b/.github/workflows/compliance.yml @@ -0,0 +1,17 @@ +name: compliance + +on: + pull_request: + +permissions: + contents: read + +jobs: + # Reference: ENGSRV-059 + copywrite: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 + - uses: hashicorp/setup-copywrite@867a1a2a064a0626db322392806428f7dc59cb3e # v1.1.2 + - run: copywrite headers --plan + - run: copywrite license --plan \ No newline at end of file diff --git a/README.md b/README.md index 151da17..5f10878 100644 --- a/README.md +++ b/README.md @@ -275,3 +275,11 @@ to `true`, the following outputs are available for subsequent steps that call th ## Experimental Status By using the software in this repository (the "Software"), you acknowledge that: (1) the Software is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp; (2) the Software is provided on an "as-is" basis, and may include bugs, errors, or other issues; (3) the Software is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of the Software; and (4) HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of the Software, at any time and without any obligation or liability whatsoever. + +## Contributing + +### License Headers + +All source code files (excluding autogenerated files like `package.json`, prose, and files excluded in [.copywrite.hcl](.copywrite.hcl)) must have a license header at the top. + +This can be autogenerated by installing the HashiCorp [`copywrite`](https://github.com/hashicorp/copywrite#getting-started) tool and running `copywrite headers` in the root of the repository.