Skip to content

Commit 16686ce

Browse files
license: removes copyright year and uses SPDX ID (#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. Signed-off-by: Adrian Cole <[email protected]>
1 parent f3b9cf7 commit 16686ce

File tree

166 files changed

+326
-1815
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+326
-1815
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,16 @@ When submitting code, please apply [Square Code Style](https://github.com/square
99
## License
1010

1111
By contributing your code, you agree to license your contribution under
12-
the terms of the [APLv2](LICENSE).
12+
the terms of the [APLv2](../LICENSE).
1313

1414
All files are released with the Apache 2.0 license.
1515

1616
If you are adding a new file it should have a header like below. This
1717
can be automatically added by running `./mvnw com.mycila:license-maven-plugin:format`.
1818

1919
```
20-
/**
21-
* Copyright 2019 The OpenZipkin Authors
22-
*
23-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
24-
* in compliance with the License. You may obtain a copy of the License at
25-
*
26-
* http://www.apache.org/licenses/LICENSE-2.0
27-
*
28-
* Unless required by applicable law or agreed to in writing, software distributed under the License
29-
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
30-
* or implied. See the License for the specific language governing permissions and limitations under
31-
* the License.
20+
/*
21+
* Copyright The OpenZipkin Authors
22+
* SPDX-License-Identifier: Apache-2.0
3223
*/
3324
```

.github/workflows/create_release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ jobs:
1919
# Prevent use of implicit GitHub Actions read-only token GITHUB_TOKEN. We don't deploy on
2020
# the tag MAJOR.MINOR.PATCH event, but we still need to deploy the maven-release-plugin master commit.
2121
token: ${{ secrets.GH_TOKEN }}
22-
fetch-depth: 1 # only need the HEAD commit as license check isn't run
2322
- name: Setup java
2423
uses: actions/setup-java@v4
2524
with:

.github/workflows/deploy.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ jobs:
3232
# Prevent use of implicit GitHub Actions read-only token GITHUB_TOKEN.
3333
# We push Javadocs to the gh-pages branch on commit.
3434
token: ${{ secrets.GH_TOKEN }}
35-
fetch-depth: 0 # allow build-bin/idl_to_gh_pages to get the full history
3635
- name: Setup java
3736
uses: actions/setup-java@v4
3837
with:

.github/workflows/test.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ jobs:
2222
steps:
2323
- name: Checkout Repository
2424
uses: actions/checkout@v4
25-
with:
26-
fetch-depth: 0 # full git history for license check
2725
- name: Setup java
2826
uses: actions/setup-java@v4
2927
with:
@@ -52,8 +50,6 @@ jobs:
5250
steps:
5351
- name: Checkout Repository
5452
uses: actions/checkout@v4
55-
with:
56-
fetch-depth: 0 # full git history for license check
5753
- name: Setup java
5854
uses: actions/setup-java@v4
5955
with:

.settings.xml

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
33
4-
Copyright 2016-2020 The OpenZipkin Authors
5-
6-
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
7-
in compliance with the License. You may obtain a copy of the License at
8-
9-
http://www.apache.org/licenses/LICENSE-2.0
10-
11-
Unless required by applicable law or agreed to in writing, software distributed under the License
12-
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
13-
or implied. See the License for the specific language governing permissions and limitations under
14-
the License.
4+
Copyright The OpenZipkin Authors
5+
SPDX-License-Identifier: Apache-2.0
156
167
-->
178
<settings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

RELEASE.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -44,31 +44,6 @@ Here's an example of a snapshot deploy with specified credentials.
4444
$ export GPG_TTY=$(tty) && GPG_PASSPHRASE=whackamole SONATYPE_USER=adrianmole SONATYPE_PASSWORD=ed6f20bde9123bbb2312b221 build-bin/build-bin/maven/maven_deploy
4545
```
4646

47-
## First release of the year
48-
49-
The license plugin verifies license headers of files include a copyright notice indicating the years a file was affected.
50-
This information is taken from git history. There's a once-a-year problem with files that include version numbers (pom.xml).
51-
When a release tag is made, it increments version numbers, then commits them to git. On the first release of the year,
52-
further commands will fail due to the version increments invalidating the copyright statement. The way to sort this out is
53-
the following:
54-
55-
Before you do the first release of the year, move the SNAPSHOT version back and forth from whatever the current is.
56-
In-between, re-apply the licenses.
57-
58-
Note: the command below is more complex than a normal project because this
59-
project has a bom.
60-
```bash
61-
$ mvn=$PWD/mvnw
62-
$ for p in ./bom .; do
63-
(cd $p
64-
$mvn versions:set -DnewVersion=3.0.1-SNAPSHOT -DgenerateBackupPoms=false
65-
$mvn -o clean install -DskipTests
66-
$mvn com.mycila:license-maven-plugin:format
67-
$mvn versions:set -DnewVersion=3.0.0-SNAPSHOT -DgenerateBackupPoms=false)
68-
done
69-
$ git commit -asm"Adjusts copyright headers for this year"
70-
```
71-
7247
## Manually releasing
7348

7449
If for some reason, you lost access to CI or otherwise cannot get automation to work, bear in mind

activemq-client/pom.xml

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
33
4-
Copyright 2016-2024 The OpenZipkin Authors
5-
6-
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
7-
in compliance with the License. You may obtain a copy of the License at
8-
9-
http://www.apache.org/licenses/LICENSE-2.0
10-
11-
Unless required by applicable law or agreed to in writing, software distributed under the License
12-
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
13-
or implied. See the License for the specific language governing permissions and limitations under
14-
the License.
4+
Copyright The OpenZipkin Authors
5+
SPDX-License-Identifier: Apache-2.0
156
167
-->
178
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

activemq-client/src/main/java/zipkin2/reporter/activemq/ActiveMQConn.java

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
/*
2-
* Copyright 2016-2024 The OpenZipkin Authors
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5-
* in compliance with the License. You may obtain a copy of the License at
6-
*
7-
* http://www.apache.org/licenses/LICENSE-2.0
8-
*
9-
* Unless required by applicable law or agreed to in writing, software distributed under the License
10-
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11-
* or implied. See the License for the specific language governing permissions and limitations under
12-
* the License.
2+
* Copyright The OpenZipkin Authors
3+
* SPDX-License-Identifier: Apache-2.0
134
*/
145
package zipkin2.reporter.activemq;
156

activemq-client/src/main/java/zipkin2/reporter/activemq/ActiveMQSender.java

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
/*
2-
* Copyright 2016-2024 The OpenZipkin Authors
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5-
* in compliance with the License. You may obtain a copy of the License at
6-
*
7-
* http://www.apache.org/licenses/LICENSE-2.0
8-
*
9-
* Unless required by applicable law or agreed to in writing, software distributed under the License
10-
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11-
* or implied. See the License for the specific language governing permissions and limitations under
12-
* the License.
2+
* Copyright The OpenZipkin Authors
3+
* SPDX-License-Identifier: Apache-2.0
134
*/
145
package zipkin2.reporter.activemq;
156

activemq-client/src/main/java/zipkin2/reporter/activemq/LazyInit.java

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
/*
2-
* Copyright 2016-2019 The OpenZipkin Authors
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5-
* in compliance with the License. You may obtain a copy of the License at
6-
*
7-
* http://www.apache.org/licenses/LICENSE-2.0
8-
*
9-
* Unless required by applicable law or agreed to in writing, software distributed under the License
10-
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11-
* or implied. See the License for the specific language governing permissions and limitations under
12-
* the License.
2+
* Copyright The OpenZipkin Authors
3+
* SPDX-License-Identifier: Apache-2.0
134
*/
145
package zipkin2.reporter.activemq;
156

0 commit comments

Comments
 (0)