Skip to content

license: removes copyright year and uses SPDX ID#224

Merged
codefromthecrypt merged 3 commits intomasterfrom
SPDX
Apr 14, 2024
Merged

license: removes copyright year and uses SPDX ID#224
codefromthecrypt merged 3 commits intomasterfrom
SPDX

Conversation

@codefromthecrypt
Copy link
Copy Markdown
Member

As a small project, we have to conserve resources and not sign up for work that isn't required. I've recently realized many commerical and/or CNCF projects both use SPDX IDs and also don't bother with copyright year. If their legal team is ok with this, surely a volunteer team without access to one, should be, too! Doing so accomplishes the following:

  • significantly increases readability of files, particularly small ones
  • removes beginning of year maintenance, which cause a lot of FUD last year. IIRC some deployment failed and hours were spent in spite of docs.
  • eliminates the need to do a full source check out, just to satisfy the license plugin. This means we can use actions/checkout defaults.

Same as openzipkin/zipkin-reporter-java#257

As a small project, we have to conserve resources and not sign up for
work that isn't required. I've recently realized many commerical and/or
CNCF projects both use SPDX IDs and also don't bother with copyright
year. If their legal team is ok with this, surely a volunteer team
without access to one, should be, too! Doing so accomplishes the
following:

* significantly increases readability of files, particularly small ones
* removes beginning of year maintenance, which cause a lot of FUD last
  year. IIRC some deployment failed and hours were spent in spite of docs.
* eliminates the need to do a full source check out, just to satisfy the
  license plugin. This means we can use actions/checkout defaults.

Same as openzipkin/zipkin-reporter-java#257

Signed-off-by: Adrian Cole <[email protected]>
@codefromthecrypt codefromthecrypt changed the title license: removes copyright year and uses SPDX ID (#257) license: removes copyright year and uses SPDX ID Apr 14, 2024
Copy link
Copy Markdown
Member Author

@codefromthecrypt codefromthecrypt left a comment

Choose a reason for hiding this comment

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

notes

# Prevent use of implicit GitHub Actions read-only token GITHUB_TOKEN. We don't deploy on
# the tag MAJOR.MINOR.PATCH event, but we still need to deploy the maven-release-plugin master commit.
token: ${{ secrets.GH_TOKEN }}
fetch-depth: 1 # only need the HEAD commit as license check isn't run
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

default is 1

# Prevent use of implicit GitHub Actions read-only token GITHUB_TOKEN.
# We push Javadocs to the gh-pages branch on commit.
token: ${{ secrets.GH_TOKEN }}
fetch-depth: 0 # allow build-bin/idl_to_gh_pages to get the full history
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

copy/pasta for zipkin and not used here

- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 1 # only needed to get the sha label
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

default is 1

- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # full git history for license check
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

no longer needed

- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 1 # -Dlicense.skip=true, so we don't need a full clone
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

default is 1

# yamllint --format github .github/workflows/test_readme.yml
---
name: readme_test
name: test_readme
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

to match zipkin

- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 1
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

default is 1

Signed-off-by: Adrian Cole <[email protected]>
@codefromthecrypt codefromthecrypt merged commit 62c0a38 into master Apr 14, 2024
@codefromthecrypt codefromthecrypt deleted the SPDX branch April 14, 2024 18:02
@codefromthecrypt
Copy link
Copy Markdown
Member Author

thanks for the look @reta!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants