Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[COMPLIANCE] Add Copyright and License Headers #145

Merged
merged 1 commit into from
Dec 21, 2022

Conversation

hashicorp-copywrite[bot]
Copy link
Contributor

@hashicorp-copywrite hashicorp-copywrite bot commented Dec 12, 2022

Hi there 👋

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

Frequently Asked Questions

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

More info is available in the RFC

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

#proj-software-copyright

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.

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 = [
    # "vendors/**",
    # "**autogen**",
  ]
}

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.

Thank you!


Made with ❤️ @hashicorp

Copy link
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

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

Overall all this looks good to me. I see that the generated files such as hclspecs and docs were not modified.

Looking at the scanner code I see that files containing "DO NOT EDIT" are treated as generated files so they are skipped. Does that mean they don't need the header? Or should we work to up our tooling to include the license header?

@nywilken
Copy link
Contributor

Merging after our internal conversation.

@nywilken nywilken merged commit b493aea into main Dec 21, 2022
@nywilken nywilken deleted the compliance/add-headers branch December 21, 2022 18:56
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