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

Add SPDX-FileCopyrightText and SPDX-FileType to source file header #291

Merged
merged 3 commits into from
Jan 31, 2025

Conversation

bact
Copy link
Collaborator

@bact bact commented Jan 31, 2025

Context

In FOSDEM 2025 SBOM side event and someone complain about source-file-level SBOM information
(in general for the whole industry, not particularly this library).

What this PR does?

  • Put copyright text to SPDX-FileCopyrightText
  • Add to source files SPDX-FileType: SOURCE
  • Add missing copyright header - using this template Copyright (c) YYYY Source Auditor Inc. where YYYY is the first year that that file appears on the GitHub repo
  • Add few missing Javadoc

Question

Do we like to keep the full license text inside the source file header? Or it can be omitted? (we already have SPDX-License-Identifier: Apache-2.0 in the source file header and have the full license text in ./LICENSE file)

  • if it can be omitted, I will push another commit to remove it

See also: spdx/spdx-java-core#28

@bact bact added the documentation Improvements or additions to documentation label Jan 31, 2025
bact added 2 commits January 31, 2025 16:03
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Use the date from first GitHub commit

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact requested a review from goneall January 31, 2025 15:19
@bact bact requested a review from pmonks January 31, 2025 15:21
@bact bact mentioned this pull request Jan 31, 2025
11 tasks
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

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

LGTM - I also updated my IDE copyright template to use these fields

@goneall goneall merged commit 9d224cd into spdx:master Jan 31, 2025
1 check passed
@bact bact deleted the update-spdx-headers branch January 31, 2025 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants