Skip to content

[COMPLIANCE] Add/Update Copyright Headers#1872

Open
hashicorp-copywrite[bot] wants to merge 1 commit into
mainfrom
compliance/add-headers
Open

[COMPLIANCE] Add/Update Copyright Headers#1872
hashicorp-copywrite[bot] wants to merge 1 commit into
mainfrom
compliance/add-headers

Conversation

@hashicorp-copywrite
Copy link
Copy Markdown

@hashicorp-copywrite hashicorp-copywrite Bot commented Jan 29, 2024

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 confluence - 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 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 29, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 35734cb to 774ff80 Compare February 26, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 774ff80 to bd4dca9 Compare March 11, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 43f015c to 2a71e41 Compare April 1, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 2a71e41 to c13ae09 Compare April 22, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 27ba3a8 to 518bb56 Compare May 6, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 39d2532 to d1c7795 Compare May 20, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from d1c7795 to 09e6c0d Compare May 27, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 09e6c0d to 93e0d70 Compare June 3, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 2f39936 to 6c69298 Compare June 17, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 250f112 to 249fca7 Compare July 1, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 249fca7 to 79ac260 Compare July 8, 2024 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 79ac260 to 7b892d7 Compare July 15, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 7b892d7 to 7110654 Compare July 22, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot requested a review from a team as a code owner November 18, 2024 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 4eba0d3 to a5a74f6 Compare February 3, 2025 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 3c81c6c to 2cb2e10 Compare February 17, 2025 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 2cb2e10 to e69c2f3 Compare April 14, 2025 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from e69c2f3 to 3f6e405 Compare May 26, 2025 16:04
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch 2 times, most recently from 4a42c5f to 7542501 Compare June 9, 2025 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 7542501 to 2b32148 Compare June 23, 2025 16:05
srahul3
srahul3 previously approved these changes Jun 24, 2025
Copy link
Copy Markdown

@srahul3 srahul3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM

@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 2b32148 to 169a9c3 Compare July 7, 2025 16:05
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 169a9c3 to a96ea14 Compare July 21, 2025 16:05
@hashicorp-copywrite hashicorp-copywrite Bot changed the title [COMPLIANCE] Add Copyright and License Headers [COMPLIANCE] Add/Update Copyright Headers May 11, 2026
@hashicorp-copywrite hashicorp-copywrite Bot force-pushed the compliance/add-headers branch from 0c36318 to 4902107 Compare May 11, 2026 04:11
@hashicorp-copywrite hashicorp-copywrite Bot requested a review from a team as a code owner May 11, 2026 04:11
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.

1 participant