Skip to content

Commit 4de886d

Browse files
authored
[COMPLIANCE] Add copyright and license headers (#255)
* add copywrite changes * [COMPLIANCE] Add copyright and license headers * Update compliance.yml
1 parent 483aa43 commit 4de886d

35 files changed

+1000
-0
lines changed

.copywrite.hcl

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
schema_version = 1
2+
3+
project {
4+
license = "MPL-2.0"
5+
copyright_year = 2020
6+
7+
header_ignore = [
8+
# changie tooling configuration and CHANGELOG entries (prose)
9+
".changes/unreleased/*.yaml",
10+
".changie.yaml",
11+
12+
# GitHub issue template configuration
13+
".github/ISSUE_TEMPLATE/*.yml",
14+
15+
# GitHub Actions workflow-specific configurations
16+
".github/labeler-*.yml",
17+
18+
# golangci-lint tooling configuration
19+
".golangci.yml",
20+
21+
# GoReleaser tooling configuration
22+
".goreleaser.yml",
23+
24+
# Release Engineering tooling configuration
25+
".release/*.hcl",
26+
]
27+
}

.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,10 @@ updates:
1313
schedule:
1414
# Check for updates to Go modules every weekday
1515
interval: "daily"
16+
17+
# Maintain dependencies for Go modules (tools)
18+
- package-ecosystem: "gomod"
19+
directory: "/tools"
20+
schedule:
21+
# Check for updates to Go modules every weekday
22+
interval: "daily"

.github/workflows/compliance.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: compliance
2+
3+
on:
4+
pull_request:
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
# Reference: ENGSRV-059
11+
copywrite:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
15+
- uses: hashicorp/setup-copywrite@867a1a2a064a0626db322392806428f7dc59cb3e # v1.1.2
16+
- run: copywrite headers --plan
17+
- run: copywrite license --plan

GNUmakefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ build:
99

1010
test:
1111
go test $(TEST) $(TESTARGS) -timeout=5m
12+
13+
# Generate copywrite headers
14+
generate:
15+
cd tools; go generate ./...

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,10 @@ and limitations. In those cases, please report [issues](https://github.com/hashi
183183
or, if you can, submit a [pull-request](https://github.com/hashicorp/terraform-plugin-docs/pulls).
184184
185185
Your help and patience is truly appreciated.
186+
187+
## Contributing
188+
189+
### License Headers
190+
All source code files in this repository (excluding autogenerated files like `go.mod`, prose, and files excluded in [.copywrite.hcl](.copywrite.hcl)) must have a license header at the top.
191+
192+
This can be autogenerated by running `make generate` or running `go generate ./...` in the [/tools](/tools) directory.

cmd/tfplugindocs/main.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
14
package main
25

36
import (

cmd/tfplugindocs/version.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
14
package main
25

36
var (

internal/cmd/generate.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
14
package cmd
25

36
import (

internal/cmd/run.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
14
package cmd
25

36
import (

internal/cmd/serve.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
14
package cmd
25

36
//TODO: this command can run an emulated server to simulate the registry

0 commit comments

Comments
 (0)