Add copyright/license headers to script files (jaegertracing#5829)

Zen-cronic · yurishkuro · JaredTan95 · commit 37d81d2d4124 · 2024-08-28T10:27:00.000+08:00
## Which problem is this PR solving? - Resolves jaegertracing#5827 ## Description of the changes - Update the `update_go_license` function to handle the `.sh` files and makefiles - Update the [ALL_SRC](https://github.com/jaegertracing/jaeger/blob/dc49b1faaeee15c2498c562309bab4fc0525bd56/Makefile#L32) variable in the main `Makefile` to include the new file types, which in turn updates the `lint` and `fmt` targets ## How was this change tested? - ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits - [ ] I have added unit tests for the new functionality - [x] I have run lint and test steps successfully - for `jaeger`: `make lint test` - for `jaeger-ui`: `yarn lint` and `yarn test` --------- Signed-off-by: Kaung Zin Hein <kaungzinhein113@gmail.com> Signed-off-by: Yuri Shkuro <github@ysh.us> Co-authored-by: Yuri Shkuro <github@ysh.us> Signed-off-by: Jared Tan <jian.tan@daocloud.io>
diff --git a/Makefile b/Makefile
@@ -42,6 +42,14 @@ ALL_SRC = $(shell find . -name '*.go' \
 				   -type f | \
 				sort)
 
+# All .sh or .py or Makefile or .mk files that should be auto-formatted and linted.
+SCRIPTS_SRC = $(shell find . \( -name '*.sh' -o -name '*.py' -o -name '*.mk' -o -name 'Makefile*' -o -name 'Dockerfile*' \) \
+						-not -path './.git/*' \
+						-not -path './idl/*' \
+						-not -path './jaeger-ui/*' \
+						-type f | \
+					sort)
+
 # ALL_PKGS is used with 'nocover' and 'goleak'
 ALL_PKGS = $(shell echo $(dir $(ALL_SRC)) | tr ' ' '\n' | sort -u)
 
@@ -185,11 +193,11 @@ fmt: $(GOFUMPT)
 	@echo Running gofumpt on ALL_SRC ...
 	@$(GOFUMPT) -e -l -w $(ALL_SRC)
 	@echo Running updateLicense.py on ALL_SRC ...
-	@./scripts/updateLicense.py $(ALL_SRC)
+	@./scripts/updateLicense.py $(ALL_SRC) $(SCRIPTS_SRC)
 
 .PHONY: lint
 lint: $(LINT) goleak
-	@./scripts/updateLicense.py $(ALL_SRC) > $(FMT_LOG)
+	@./scripts/updateLicense.py $(ALL_SRC) $(SCRIPTS_SRC) > $(FMT_LOG)
 	@./scripts/import-order-cleanup.py -o stdout -t $(ALL_SRC) > $(IMPORT_LOG)
 	@[ ! -s "$(FMT_LOG)" -a ! -s "$(IMPORT_LOG)" ] || (echo "License check or import ordering failures, run 'make fmt'" | cat - $(FMT_LOG) $(IMPORT_LOG) && false)
 	./scripts/check-semconv-version.sh
diff --git a/cmd/agent/Dockerfile b/cmd/agent/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/all-in-one/Dockerfile b/cmd/all-in-one/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/anonymizer/Dockerfile b/cmd/anonymizer/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM scratch
 ARG TARGETARCH
 ARG USER_UID=10001
diff --git a/cmd/collector/Dockerfile b/cmd/collector/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/es-index-cleaner/Dockerfile b/cmd/es-index-cleaner/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 
 FROM $base_image AS release
diff --git a/cmd/es-rollover/Dockerfile b/cmd/es-rollover/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 
 FROM $base_image AS release
diff --git a/cmd/ingester/Dockerfile b/cmd/ingester/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/jaeger/Dockerfile b/cmd/jaeger/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/query/Dockerfile b/cmd/query/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/remote-storage/Dockerfile b/cmd/remote-storage/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG base_image
 ARG debug_image
 
diff --git a/cmd/tracegen/Dockerfile b/cmd/tracegen/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM scratch
 ARG TARGETARCH
 ARG USER_UID=10001
diff --git a/crossdock/Dockerfile b/crossdock/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM scratch
 ARG TARGETARCH
 
diff --git a/crossdock/rules.mk b/crossdock/rules.mk
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 XDOCK_YAML=crossdock/docker-compose.yml
 
 JAEGER_COMPOSE_YAML ?= crossdock/jaeger-docker-compose.yml
diff --git a/docker-compose/monitor/Makefile b/docker-compose/monitor/Makefile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 BINARY ?= all-in-one # Default value uses v1 binary
 
 .PHONY: build
diff --git a/docker/Makefile b/docker/Makefile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 VERSION := 1.0.0
 
 DOCKER_REGISTRY ?= localhost:5000
diff --git a/docker/base/Dockerfile b/docker/base/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM alpine:3.20.2 AS cert
 RUN apk add --update --no-cache ca-certificates mailcap
 
diff --git a/docker/debug/Dockerfile b/docker/debug/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM golang:1.22.6-alpine AS build
 ARG TARGETARCH
 ENV GOPATH /go
diff --git a/examples/hotrod/Dockerfile b/examples/hotrod/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM scratch
 ARG TARGETARCH
 EXPOSE 8080 8081 8082 8083
diff --git a/pkg/config/tlscfg/testdata/gen-certs.sh b/pkg/config/tlscfg/testdata/gen-certs.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 # The following commands were used to create the CA, server and client's certificates and keys in this directory used by unit tests.
 # These certificates use the Subject Alternative Name extension rather than the Common Name, which will be unsupported in Go 1.15.
 
diff --git a/plugin/storage/cassandra/Dockerfile b/plugin/storage/cassandra/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 FROM cassandra:5.0
 
 COPY schema/* /cassandra-schema/
diff --git a/plugin/storage/cassandra/schema/create.sh b/plugin/storage/cassandra/schema/create.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 function usage {
     >&2 echo "Error: $1"
     >&2 echo ""
diff --git a/plugin/storage/cassandra/schema/docker.sh b/plugin/storage/cassandra/schema/docker.sh
@@ -1,4 +1,7 @@
 #!/usr/bin/env bash
+
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
 #
 # This script is used in the Docker image jaegertracing/jaeger-cassandra-schema
 # that allows installing Jaeger keyspace and schema without installing cqlsh.
diff --git a/plugin/storage/cassandra/schema/migration/V002toV003.sh b/plugin/storage/cassandra/schema/migration/V002toV003.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 # Create a new operation_names_v2 table and copy all data from operation_names table
 # Sample usage: KEYSPACE=jaeger_v1 CQL_CMD='cqlsh host 9042 -u test_user -p test_password --request-timeout=3000' bash
 # ./v002tov003.sh
diff --git a/plugin/storage/cassandra/schema/migration/v001tov002part1.sh b/plugin/storage/cassandra/schema/migration/v001tov002part1.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 function usage {
diff --git a/plugin/storage/cassandra/schema/migration/v001tov002part2.sh b/plugin/storage/cassandra/schema/migration/v001tov002part2.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 function usage {
diff --git a/scripts/adaptive-sampling-integration-test.sh b/scripts/adaptive-sampling-integration-test.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euf -o pipefail
 
 # This script is currently a placeholder.
diff --git a/scripts/build-all-in-one-image.sh b/scripts/build-all-in-one-image.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euf -o pipefail
 
 print_help() {
diff --git a/scripts/build-crossdock.sh b/scripts/build-crossdock.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euxf -o pipefail
 
 BRANCH=${BRANCH:?'missing BRANCH env var'}
diff --git a/scripts/build-upload-a-docker-image.sh b/scripts/build-upload-a-docker-image.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euf -o pipefail
 
 base_debug_img_arg=""
diff --git a/scripts/build-upload-docker-images.sh b/scripts/build-upload-docker-images.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euf -o pipefail
 
 print_help() {
diff --git a/scripts/cassandra-integration-test.sh b/scripts/cassandra-integration-test.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -uxf -o pipefail
 
 usage() {
diff --git a/scripts/check-go-version.sh b/scripts/check-go-version.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 version_regex='[0-9]\.[0-9][0-9]'
 update=false
 verbose=false
diff --git a/scripts/check-goleak-files.sh b/scripts/check-goleak-files.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 bad_pkgs=0
diff --git a/scripts/check-semconv-version.sh b/scripts/check-semconv-version.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euf -o pipefail
 
 package_name="go.opentelemetry.io/otel/semconv"
diff --git a/scripts/compare_metrics.py b/scripts/compare_metrics.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 import json
 
 v1_metrics_path = "./V1_Metrics.json"
diff --git a/scripts/compute-tags.sh b/scripts/compute-tags.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 # Compute major/minor/etc image tags based on the current branch
 
 set -ef -o pipefail
diff --git a/scripts/compute-tags.test.sh b/scripts/compute-tags.test.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 # This script uses https://github.com/kward/shunit2 to run unit tests.
 # The path to this repo must be provided via SHUNIT2 env var.
 
diff --git a/scripts/dco_check.py b/scripts/dco_check.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 # Script copied from https://github.com/christophebedard/dco-check/blob/master/dco_check/dco_check.py
 #
 # Copyright 2020 Christophe Bedard
diff --git a/scripts/docker-login.sh b/scripts/docker-login.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -exu
 
 DOCKERHUB_USERNAME=${DOCKERHUB_USERNAME:-"jaegertracingbot"}
diff --git a/scripts/draft-release.py b/scripts/draft-release.py
@@ -1,5 +1,8 @@
 #!/usr/bin/env python3
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 import argparse
 import re
 import subprocess
diff --git a/scripts/es-integration-test.sh b/scripts/es-integration-test.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 PS4='T$(date "+%H:%M:%S") '
 set -euf -o pipefail
 
diff --git a/scripts/generate-help-output.sh b/scripts/generate-help-output.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 # This script runs the `help` command on all Jaeger binaries (using go run) with variations of SPAN_STORAGE_TYPE.
 # It can be used to compare the CLI API changes between releases.
 
diff --git a/scripts/hotrod-integration-test.sh b/scripts/hotrod-integration-test.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euxf -o pipefail
 
 print_help() {
diff --git a/scripts/import-order-cleanup.py b/scripts/import-order-cleanup.py
@@ -1,5 +1,8 @@
 #!/usr/bin/env python3
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 import argparse
 
 def cleanup_imports_and_return(imports):
diff --git a/scripts/kafka-integration-test.sh b/scripts/kafka-integration-test.sh
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euf -o pipefail
 
 compose_file="docker-compose/kafka-integration-test/docker-compose.yml"
diff --git a/scripts/package-deploy.sh b/scripts/package-deploy.sh
@@ -1,4 +1,7 @@
 #!/bin/bash
+
+# Copyright (c) 2024 The Jaeger Authors.
+# SPDX-License-Identifier: Apache-2.0
 set -euxf -o pipefail
 
 TARCMD=${TARCMD:-tar}
diff --git a/scripts/rebuild-ui.sh b/scripts/rebuild-ui.sh
diff --git a/scripts/release-notes.py b/scripts/release-notes.py
diff --git a/scripts/spm-integration-test.sh b/scripts/spm-integration-test.sh
diff --git a/scripts/update-semconv-version.sh b/scripts/update-semconv-version.sh
diff --git a/scripts/updateLicense.py b/scripts/updateLicense.py
diff --git a/scripts/utils/ids-to-base64.py b/scripts/utils/ids-to-base64.py
