Skip to content

Conversation

@codefromthecrypt
Copy link
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 commercial 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, all of which help volunteers:

  • 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 change as openzipkin/zipkin-reporter-java#257)

token: ${{ secrets.GH_TOKEN }}
# allow build-bin/javadoc_to_gh_pages to get the full history
# Allow build-bin/javadoc_to_gh_pages to fetch and push gh-pages
# See https://github.com/actions/checkout/issues/578
Copy link
Member Author

Choose a reason for hiding this comment

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

notable thing is the comment was imprecise

As a small project, we have to conserve resources and not sign up for work that isn't required. I've recently realized many [commercial](https://github.com/hashicorp/consul/blob/main/command/cli/cli.go#L1-L2) and/or [CNCF projects](https://github.com/open-telemetry/opentelemetry-java/blob/main/api/all/src/main/java/io/opentelemetry/api/trace/Tracer.java#L1-L4) 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, all of which help volunteers:
* 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.

Signed-off-by: Adrian Cole <[email protected]>
Signed-off-by: Adrian Cole <[email protected]>
@codefromthecrypt
Copy link
Member Author

one nice side effect is the raw HTML isn't dominated by license text anymore ;)

$ curl -s localhost:9411/zipkin/index.html
<!--

    Copyright The OpenZipkin Authors
    SPDX-License-Identifier: Apache-2.0

-->
<!DOCTYPE html>
<html>
  <head>
    <base href="/zipkin" >
    <meta charset="utf-8" />
    <link rel="icon" href="/zipkin/favicon.ico" />
    <title>Zipkin</title>
    <script type="module" crossorigin src="/zipkin/static/js/index.51c4d5b0.js"></script>
    <link rel="stylesheet" href="/zipkin/static/css/index.a7aa86b4.css">
  </head>
  <body>
    <noscript>You need to enable JavaScript to run this app.</noscript>
    <div id="root"></div>
    
  </body>
</html>

@codefromthecrypt codefromthecrypt merged commit dad4182 into master Mar 5, 2024
@codefromthecrypt codefromthecrypt deleted the SPDX branch March 5, 2024 09:08
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.

3 participants