ci: auto-insert Apache license headers via Lucas-C/insert-license

potiuk · potiuk · commit dcb630b00a42 · 2026-04-25T18:52:57.000+02:00
Add Lucas-C/pre-commit-hooks insert-license to .pre-commit-config.yaml covering every file type that's actually present in the repo: .py .yml/.yaml .toml .sh .ezt Dockerfile/*.Dockerfile .md Hooks share a single license template (scripts/license-templates/LICENSE.txt) and the canonical wrapped '#'-comment style ('#|#|#') used by the majority of existing files. Markdown uses '' to match the existing 2-space-indented HTML-comment style. Exclusions are scoped narrowly: * approved_patterns.yml — auto-generated from actions.yml. * stash/* (except stash/pyproject.toml) — uses the short-form 'Copyright (c) The stash contributors / Licensed under Apache 2.0' style which RAT accepts. * .github/workflows/stash-action-test.yml — same short-form. * AGENTS.md / CLAUDE.md — agentic-tooling docs that follow the short-license convention used in apache/airflow. Drive-by normalisation across files outside stash/: * 17 files had unwrapped headers ('# Licensed' on line 1, no surrounding '#' lines) — wrapped to the canonical style so the hook is a no-op on subsequent runs. * pelican/plugins/spu.py and pelican/plugin_paths.py had legacy near-identical license blocks (slightly different wrap, https vs http URL) — replaced with the canonical block; the duplicate that insert-license added on first run was removed manually. Motivation: PR #770 shipped a new file (lock_file_exemptions.yml) without an ASF license header, which the rat check correctly caught but only after the PR was opened and reviewed. Running this hook locally would have flagged it before push.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -15,6 +16,7 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+#
 ---
 name: "CodeQL"
 
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -15,6 +16,7 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+#
 ---
 name: Pre-commit Checks
 
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -15,6 +16,7 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+#
 name: pytest
 
 on:
diff --git a/.github/workflows/rat.yml b/.github/workflows/rat.yml
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -15,6 +16,7 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+#
 name: rat
 
 on:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -14,6 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+#
 ---
 default_stages: [pre-commit]
 default_language_version:
@@ -28,4 +30,93 @@ repos:
         language: python
         additional_dependencies: ['rich>=12.4.4', 'ruamel.yaml']
         require_serial: true
-        files: ^actions\.yml$
+        files: ^actions\.yml$
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.6
+    hooks:
+      # Files in stash/ (except stash/pyproject.toml) carry the short-form
+      # Apache 2.0 license ("Copyright (c) The stash contributors / Licensed
+      # under the Apache License, Version 2.0") which RAT accepts. Adding the
+      # full ASF contributor header on top would just duplicate, so they are
+      # excluded across every ecosystem-specific hook below.
+      - id: insert-license
+        name: Add Apache license header to Python files
+        files: \.py$
+        exclude: ^stash/(?!pyproject\.toml).*$
+        args:
+          - --comment-style
+          - "#|#|#"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add Apache license header to YAML files
+        files: \.ya?ml$
+        # approved_patterns.yml is regenerated from actions.yml by gateway/.
+        # stash-action-test.yml uses the short-form Apache 2.0 license to
+        # match the rest of the stash sub-project.
+        exclude: |
+          (?x)
+          ^approved_patterns\.yml$|
+          ^stash/(?!pyproject\.toml).*$|
+          ^\.github/workflows/stash-action-test\.yml$
+        args:
+          - --comment-style
+          - "#|#|#"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add Apache license header to TOML files
+        files: \.toml$
+        args:
+          - --comment-style
+          - "#|#|#"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add Apache license header to shell scripts
+        files: \.(sh|bash)$
+        args:
+          - --comment-style
+          - "#|#|#"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add Apache license header to Dockerfiles
+        files: (^|/)Dockerfile$|\.Dockerfile$
+        args:
+          - --comment-style
+          - "#|#|#"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add Apache license header to ezt templates
+        files: \.ezt$
+        args:
+          - --comment-style
+          - "#|#|#"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add Apache license header to Markdown files
+        files: \.md$
+        # CLAUDE.md / AGENTS.md are agentic-tooling docs that follow the
+        # short-license convention used in apache/airflow; keeping them
+        # exempted here matches that convention until we add the short
+        # template too. stash/README.md uses the short-form Apache license.
+        exclude: |
+          (?x)
+          ^(?:.*/)?AGENTS\.md$|
+          ^(?:.*/)?CLAUDE\.md$|
+          ^stash/.*\.md$
+        args:
+          - --comment-style
+          - "<!--|  |-->"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
diff --git a/allowlist-check/action.yml b/allowlist-check/action.yml
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -14,6 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+#
 
 name: "ASF Allowlist Check"
 description: >
diff --git a/allowlist-check/check_asf_allowlist.py b/allowlist-check/check_asf_allowlist.py
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -14,6 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+#
 
 """Check that all GitHub Actions uses: refs are on the ASF allowlist.
 
diff --git a/allowlist-check/insert_actions.py b/allowlist-check/insert_actions.py
@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -15,6 +16,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+#
 """Insert action entries into actions.yml in alphabetical order.
 
 Usage:
diff --git a/allowlist-check/test_check_asf_allowlist.py b/allowlist-check/test_check_asf_allowlist.py
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -14,6 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+#
 
 import os
 import shutil
diff --git a/license-templates/LICENSE.txt b/license-templates/LICENSE.txt
@@ -0,0 +1,16 @@
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, 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.
diff --git a/pelican/plugin_paths.py b/pelican/plugin_paths.py
@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*- #
-# vim: encoding=utf-8
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
@@ -10,7 +9,7 @@
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
 #
-#   https://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
diff --git a/pelican/plugins/asfcopy.py b/pelican/plugins/asfcopy.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python -B
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -19,6 +20,7 @@
 #
 # asfcopy.py -- Pelican plugin that copies trees during finalization
 #
+#
 
 import sys
 import shutil
diff --git a/pelican/plugins/asfdata.py b/pelican/plugins/asfdata.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python -B
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -19,6 +20,7 @@
 #
 # asfdata.py -- Pelican plugin that processes a yaml specification of data into a setting directory
 #
+#
 
 import os.path
 import sys
diff --git a/pelican/plugins/asfindex.py b/pelican/plugins/asfindex.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python -B
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -19,6 +20,7 @@
 #
 # asfindex.py - Pelican plugin that generates indexes
 #
+#
 
 import sys
 import os
diff --git a/pelican/plugins/asfreader.py b/pelican/plugins/asfreader.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python -B
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -19,6 +20,7 @@
 #
 # asfreader.py -- Pelican plugin that processes ezt template Markdown through ezt and  then GitHub Flavored Markdown.
 #
+#
 
 import sys
 import io
diff --git a/pelican/plugins/asfrun.py b/pelican/plugins/asfrun.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python -B
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -19,6 +20,7 @@
 #
 # asfrun.py - Pelican plugin that runs shell scripts during initialization or finalization
 #
+#
 
 import os
 import sys
diff --git a/pelican/plugins/consensual_youtube.py b/pelican/plugins/consensual_youtube.py
@@ -1,4 +1,5 @@
 #!/usr/bin/python -B
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -30,6 +31,7 @@
 # The preview image will be taken from `img/{youtube_id}.jpg` in your content
 # folder. If no preview image is found there, it will be fetched from youtube
 # at site generation time.
+#
 from os import path
 
 from urllib import request
diff --git a/pelican/plugins/spu.py b/pelican/plugins/spu.py
@@ -1,19 +1,23 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements.  See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License.  You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, 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.
 #
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# 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.
 
 """
 This is a collection of simple in-page callable tools for pelican.
diff --git a/scripts/sort_yml.py b/scripts/sort_yml.py
@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -23,6 +24,7 @@
 #     "ruamel.yaml",
 # ]
 # ///
+#
 
 from ruamel.yaml import YAML
 from ruamel.yaml.comments import CommentedMap
diff --git a/utils/verify_action_build/dockerfiles/build_action.Dockerfile b/utils/verify_action_build/dockerfiles/build_action.Dockerfile
@@ -1,3 +1,4 @@
+#
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
@@ -18,6 +19,7 @@
 # Dockerfile for rebuilding a GitHub Action's compiled JavaScript
 # in an isolated container.  Used by verify-action-build to compare
 # published dist/ output against a from-scratch rebuild.
+#
 
 ARG NODE_VERSION=20
 FROM node:${NODE_VERSION}-slim
