.github/workflows/linter.yaml

@@ -10,9 +10,12 @@ jobs:
     runs-on: ${{ matrix.platform }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+    - uses: actions/setup-go@v3
+      with:
+        go-version: ${{ matrix.go-version }}
 
     - name: golangci-lint
-      uses: golangci/golangci-lint-action@v2
+      uses: golangci/golangci-lint-action@v3
       with:
-        version: v1.41
+        version: v1.45

.github/workflows/release.yaml

@@ -15,14 +15,14 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       -
         name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
-          go-version: 1.16
+          go-version: 1.18
       -
         name: Run GoReleaser
         uses: goreleaser/goreleaser-action@5a54d7e660bda43b405e8463261b3d25631ffe86 #v2.7.0
@@ -45,7 +45,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Log in to the Container registry
         uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9 #v1.10.0

.github/workflows/tests.yaml

@@ -24,13 +24,13 @@ jobs:
       with:
         access_token: ${{ github.token }}
 
-    - uses: actions/setup-go@v2
+    - uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.go-version }}
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Cache go modules
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: |
           ~/.cache/go-build
@@ -43,4 +43,4 @@ jobs:
 
     - name: Upload coverage to Codecov
       if: ${{ matrix.update-coverage }}
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v3

README.md

@@ -10,41 +10,58 @@ addlicense requires go 1.16 or later.
 
 ## install
 
-    go get -u github.com/google/addlicense
+    go install github.com/google/addlicense@latest
 
 ## usage
 
     addlicense [flags] pattern [pattern ...]
 
-    -c copyright holder (defaults to "Google LLC")
-    -f custom license file (no default)
-    -l license type: apache, bsd, mit, mpl (defaults to "apache")
-    -y year (defaults to current year)
-    -check check only mode: verify presence of license headers and exit with non-zero code if missing
+    -c      copyright holder (default "Google LLC")
+    -check  check only mode: verify presence of license headers and exit with non-zero code if missing
+    -f      license file
     -ignore file patterns to ignore, for example: -ignore **/*.go -ignore vendor/**
+    -l      license type: apache, bsd, mit, mpl (default "apache")
+    -s      Include SPDX identifier in license header. Set -s=only to only include SPDX identifier.
+    -v      verbose mode: print the name of the files that are modified
+    -y      copyright year(s) (default "2022")
 
 The pattern argument can be provided multiple times, and may also refer
-to single files.
+to single files.  Directories are processed recursively.
+
+For example, to run addlicense across everything in the current directory and
+all subdirectories:
+
+    addlicense .
 
 The `-ignore` flag can use any pattern [supported by
 doublestar](https://github.com/bmatcuk/doublestar#patterns).
 
 ## Running in a Docker Container
 
-- Clone the repository using `git clone https://github.com/google/addlicense.git`
-- Build your docker container
+The simplest way to get the addlicense docker image is to pull from GitHub
+Container Registry:
+
 ```bash
-docker build -t google/addlicense .
+docker pull ghcr.io/google/addlicense:latest
 ```
 
-- Test the image
+Alternately, you can build it from source yourself:
+
 ```bash
-docker run -it google/addlicense -h
+docker build -t ghcr.io/google/addlicense .
 ```
 
-- Usage example
+Once you have the image, you can test that it works by running:
+
+```bash
+docker run -it ghcr.io/google/addlicense -h
+```
+
+Finally, to run it, mount the directory you want to scan to `/src` and pass the
+appropriate addlicense flags:
+
 ```bash
-docker run -v ${PWD}:/src -it google/addlicense -c "Google LLC" *.go
+docker run -it -v ${PWD}:/src ghcr.io/google/addlicense -c "Google LLC" *.go
 ```
 
 ## license

main.go

@@ -46,6 +46,7 @@ The pattern argument can be provided multiple times, and may also refer
 to single files.
 
 Flags:
+
 `
 
 var (
@@ -57,13 +58,13 @@ var (
 	license   = flag.String("l", "apache", "license type: apache, bsd, mit, mpl")
 	licensef  = flag.String("f", "", "license file")
 	year      = flag.String("y", fmt.Sprint(time.Now().Year()), "copyright year(s)")
-	verbose   = flag.Bool("v", false, "verbose mode: print the name of the files that are modified")
+	verbose   = flag.Bool("v", false, "verbose mode: print the name of the files that are modified or were skipped")
 	checkonly = flag.Bool("check", false, "check only mode: verify presence of license headers and exit with non-zero code if missing")
 )
 
 func init() {
 	flag.Usage = func() {
-		fmt.Fprintln(os.Stderr, helpText)
+		fmt.Fprint(os.Stderr, helpText)
 		flag.PrintDefaults()
 	}
 	flag.Var(&skipExtensionFlags, "skip", "[deprecated: see -ignore] file extensions to skip, for example: -skip rb -skip go")
@@ -216,7 +217,9 @@ func walk(ch chan<- *file, start string) error {
 			return nil
 		}
 		if fileMatches(path, ignorePatterns) {
-			log.Printf("skipping: %s", path)
+			if *verbose {
+				log.Printf("skipping: %s", path)
+			}
 			return nil
 		}
 		ch <- &file{path, fi.Mode()}
@@ -277,19 +280,22 @@ func fileHasLicense(path string) (bool, error) {
 	return hasLicense(b) || isGenerated(b), nil
 }
 
+// licenseHeader populates the provided license template with data, and returns
+// it with the proper prefix for the file type specified by path. The file does
+// not need to actually exist, only its name is used to determine the prefix.
 func licenseHeader(path string, tmpl *template.Template, data licenseData) ([]byte, error) {
 	var lic []byte
 	var err error
-	switch fileExtension(path) {
-	default:
-		return nil, nil
+	base := strings.ToLower(filepath.Base(path))
+
+	switch fileExtension(base) {
 	case ".c", ".h", ".gv", ".java", ".scala", ".kt", ".kts":
 		lic, err = executeTemplate(tmpl, data, "/*", " * ", " */")
 	case ".js", ".mjs", ".cjs", ".jsx", ".tsx", ".css", ".scss", ".sass", ".tf", ".ts":
 		lic, err = executeTemplate(tmpl, data, "/**", " * ", " */")
 	case ".cc", ".cpp", ".cs", ".go", ".hcl", ".hh", ".hpp", ".m", ".mm", ".proto", ".rs", ".swift", ".dart", ".groovy", ".v", ".sv":
 		lic, err = executeTemplate(tmpl, data, "", "// ", "")
-	case ".py", ".sh", ".yaml", ".yml", ".dockerfile", "dockerfile", ".rb", "gemfile", ".tcl", ".bzl":
+	case ".py", ".sh", ".yaml", ".yml", ".dockerfile", "dockerfile", ".rb", "gemfile", ".tcl", ".bzl", ".pl", ".pp", "build":
 		lic, err = executeTemplate(tmpl, data, "", "# ", "")
 	case ".el", ".lisp":
 		lic, err = executeTemplate(tmpl, data, "", ";; ", "")
@@ -303,15 +309,22 @@ func licenseHeader(path string, tmpl *template.Template, data licenseData) ([]by
 		lic, err = executeTemplate(tmpl, data, "", "// ", "")
 	case ".ml", ".mli", ".mll", ".mly":
 		lic, err = executeTemplate(tmpl, data, "(**", "   ", "*)")
+	default:
+		// handle various cmake files
+		if base == "cmakelists.txt" || strings.HasSuffix(base, ".cmake.in") || strings.HasSuffix(base, ".cmake") {
+			lic, err = executeTemplate(tmpl, data, "", "# ", "")
+		}
 	}
 	return lic, err
 }
 
+// fileExtension returns the file extension of name, or the full name if there
+// is no extension.
 func fileExtension(name string) string {
 	if v := filepath.Ext(name); v != "" {
-		return strings.ToLower(v)
+		return v
 	}
-	return strings.ToLower(filepath.Base(name))
+	return name
 }
 
 var head = []string{

main_test.go

@@ -316,7 +316,7 @@ func TestLicenseHeader(t *testing.T) {
 			"// HYS\n\n",
 		},
 		{
-			[]string{"f.py", "f.sh", "f.yaml", "f.yml", "f.dockerfile", "dockerfile", "f.rb", "gemfile", "f.tcl", "f.bzl"},
+			[]string{"f.py", "f.sh", "f.yaml", "f.yml", "f.dockerfile", "dockerfile", "f.rb", "gemfile", "f.tcl", "f.bzl", "f.pl", "f.pp", "build"},
 			"# HYS\n\n",
 		},
 		{
@@ -339,6 +339,16 @@ func TestLicenseHeader(t *testing.T) {
 			[]string{"f.ml", "f.mli", "f.mll", "f.mly"},
 			"(**\n   HYS\n*)\n\n",
 		},
+		{
+			[]string{"cmakelists.txt", "f.cmake", "f.cmake.in"},
+			"# HYS\n\n",
+		},
+
+		// ensure matches are case insenstive
+		{
+			[]string{"F.PY", "DoCkErFiLe"},
+			"# HYS\n\n",
+		},
 	}
 
 	for _, tt := range tests {

tmpl.go

@@ -101,7 +101,7 @@ func executeTemplate(t *template.Template, d licenseData, top, mid, bot string)
 	return out.Bytes(), nil
 }
 
-const tmplApache = `Copyright {{.Year}} {{.Holder}}
+const tmplApache = `Copyright{{ if .Year }} {{.Year}}{{ end }} {{.Holder}}
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -115,11 +115,11 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.`
 
-const tmplBSD = `Copyright (c) {{.Year}} {{.Holder}} All rights reserved.
+const tmplBSD = `Copyright (c){{ if .Year }} {{.Year}}{{ end }} {{.Holder}} All rights reserved.
 Use of this source code is governed by a BSD-style
 license that can be found in the LICENSE file.`
 
-const tmplMIT = `Copyright (c) {{.Year}} {{.Holder}}
+const tmplMIT = `Copyright (c){{ if .Year }} {{.Year}}{{ end }} {{.Holder}}
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -142,7 +142,7 @@ const tmplMPL = `This Source Code Form is subject to the terms of the Mozilla Pu
 License, v. 2.0. If a copy of the MPL was not distributed with this
 file, You can obtain one at https://mozilla.org/MPL/2.0/.`
 
-const tmplSPDX = `{{ if and .Year .Holder }}Copyright {{.Year}} {{.Holder}}
+const tmplSPDX = `{{ if .Holder }}Copyright{{ if .Year }} {{.Year}}{{ end }} {{.Holder}}
 {{ end }}SPDX-License-Identifier: {{.SPDXID}}`
 
 const spdxSuffix = "\n\nSPDX-License-Identifier: {{.SPDXID}}"