Skip to content

[COMPLIANCE] Add/Update Copyright and License Headers#587

Draft
hashicorp-copywrite[bot] wants to merge 1 commit intomainfrom
compliance/add-headers
Draft

[COMPLIANCE] Add/Update Copyright and License Headers#587
hashicorp-copywrite[bot] wants to merge 1 commit intomainfrom
compliance/add-headers

Conversation

@hashicorp-copywrite
Copy link
Contributor

Hi there 👋

This PR was auto-generated as part of an internal review of all Hashicorp repositories that are not in compliance with IBM's licensing standards.

Frequently Asked Questions

FAQs can be found in this document - FAQ Document

Why am I getting this PR? This pull request was created because one or more source code files were found either missing or incorrect copyright and/or license headers.

More info is available in these documents - MEMO, IBM Format Migration Document
Old RFC Reference for Hashicorp Copyright - RFC

How do you determine which files should get copyright headers? Attempts are made to skip scanning autogenerated files (e.g., `go.mod`) and prose. If you find file types you feel should be excluded from future scans, please reach out to:

#proj-software-copyright

How does copywrite know which files to ignore for headers? Copywrite’s goal is to focus on code, skipping common formats for prose (.txt, .md, etc). The list of supported file extensions is available [here](https://github.com/hashicorp/copywrite/blob/main/addlicense/main.go#L356-L393). Any files not listed here will be skipped by default, but please reach out to [#proj-software-copyright](https://ibm.enterprise.slack.com/archives/C09KHQ7S18F) if you notice any files that should be supported but aren’t.

Additional folders can be skipped by adding using the header_ignore config section, documented here.

My project generates code, does that generated code need copyright headers? Yes: if the generated code contains IBM's intellectual property (i.e., we build an autogenerator that creates a client SDK based off of a swagger doc), the code that gets autogenerated should have headers. Common autogenerated code managed by some other system (think go.mod, go.sum, package.lock files) will not need headers.
My project includes protobuf files (*proto), plus their autogenerated counterparts (ex. *.pb.go). Should these files have headers? Yes, protobuf files should include the headers. You might want to run `copywrite` first to make sure your *.proto files have headers. When you run your tooling to generate the language-specific proto files, you should also see headers at the top of those generated files.
I have a file or folder which should be exempted, how do I do that? You may exempt certain files or folders from being scanned by adding a `.copywrite.hcl` config in the root of your repo. You can use the [`copywrite init`](https://go.hashi.co/copywrite) command to interactively create a config for this project.

An example schema can be found below. Add a doublestar**-capable pattern to the header_ignore list to skip it in future scans.

# (OPTIONAL) Overrides the copywrite config schema version
# Default: 1
schema_version = 1

project {
  # (OPTIONAL) SPDX-compatible license identifier
  # Leave blank if you don't wish to license the project
  # Default: "MPL-2.0"
  # license = ""

  # (OPTIONAL) Represents the year that the project initially began
  # Default: <the year the repo was first created>
  # copyright_year = 0

  # (OPTIONAL) A list of globs that should not have copyright or license headers .
  # Supports doublestar glob patterns for more flexibility in defining which
  # files or folders should be ignored
  # Default: []
  header_ignore = [
    # "vendor/**",
    # "**autogen**",
  ]
}

More information about configuration options is available in [the documentation](https://github.com/hashicorp/copywrite#config-structure).

Please approve and merge this PR in a timely manner to keep this source code compliant with our OSS license agreement. If you have any questions or feedback, reach out to #proj-software-copyright.
More information is available in the MEMO.

Thank you!


Powered by copywrite, made with ❤️ by @hashicorp

@hashicorp-copywrite hashicorp-copywrite bot requested a review from a team as a code owner January 28, 2026 16:23
@mohanmanikanta2299 mohanmanikanta2299 marked this pull request as draft February 3, 2026 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants