chore: consolidate template file headers

SilverRainZ · VoxlyAi-studios · SilverRainZ · commit 250f987773f6 · 2026-03-22T19:16:47.000+08:00
Co-authored-by: OpenAI &lt;support@openai.com&gt;
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -8,6 +8,8 @@
 
     "github_owner": "sphinx-notes",
     "github_repo": "{{ cookiecutter.name }}",
+    "generated_file_header": "This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.",
+    "dont_edit_header": "DO NOT EDIT.",
     "pypi_name": "{{ cookiecutter.full_name }}",
     "pypi_owner": "SilverRainZ",
 
diff --git a/{{cookiecutter.name}}/.github/workflows/lint.yml b/{{cookiecutter.name}}/.github/workflows/lint.yml
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 name: Ruff
 on: [ push, pull_request ]
 
diff --git a/{{cookiecutter.name}}/.github/workflows/pages.yml b/{{cookiecutter.name}}/.github/workflows/pages.yml
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 name: Deploy Sphinx documentation to Pages
 
 # Runs on pushes targeting the default branch
diff --git a/{{cookiecutter.name}}/.github/workflows/pypi.yml b/{{cookiecutter.name}}/.github/workflows/pypi.yml
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 name: Publish package distributions to PyPI
 
 on:
diff --git a/{{cookiecutter.name}}/.github/workflows/release.yml b/{{cookiecutter.name}}/.github/workflows/release.yml
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 name: Publish Github Release
 
 on:
diff --git a/{{cookiecutter.name}}/.github/workflows/test.yml b/{{cookiecutter.name}}/.github/workflows/test.yml
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 name: Test
 on:
   push:
diff --git a/{{cookiecutter.name}}/.gitignore b/{{cookiecutter.name}}/.gitignore
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
diff --git a/{{cookiecutter.name}}/.pre-commit-config.yaml b/{{cookiecutter.name}}/.pre-commit-config.yaml
@@ -1,3 +1,5 @@
+# {{ cookiecutter.generated_file_header }}
+
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.14.11
diff --git a/{{cookiecutter.name}}/MANIFEST.in b/{{cookiecutter.name}}/MANIFEST.in
@@ -1,5 +1,4 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+# {{ cookiecutter.generated_file_header }}
 
 include LICENSE
 include README.rst
diff --git a/{{cookiecutter.name}}/Makefile b/{{cookiecutter.name}}/Makefile
@@ -1,5 +1,4 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+# {{ cookiecutter.generated_file_header }}
 
 LANG = en_US.UTF-8
 
diff --git a/{{cookiecutter.name}}/README.rst b/{{cookiecutter.name}}/README.rst
@@ -1,5 +1,4 @@
-.. This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+.. {{ cookiecutter.generated_file_header }}
 
 {% for _ in cookiecutter.full_name %}={% endfor %}
 {{ cookiecutter.full_name }}
diff --git a/{{cookiecutter.name}}/docs/Makefile b/{{cookiecutter.name}}/docs/Makefile
@@ -1,5 +1,4 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+# {{ cookiecutter.generated_file_header }}
 
 # Minimal makefile for Sphinx documentation
 
diff --git a/{{cookiecutter.name}}/docs/_images/.gitkeep b/{{cookiecutter.name}}/docs/_images/.gitkeep
@@ -0,0 +1 @@
+# {{ cookiecutter.generated_file_header }}
diff --git a/{{cookiecutter.name}}/docs/_static/.gitkeep b/{{cookiecutter.name}}/docs/_static/.gitkeep
@@ -0,0 +1 @@
+# {{ cookiecutter.generated_file_header }}
diff --git a/{{cookiecutter.name}}/docs/_static/custom.css b/{{cookiecutter.name}}/docs/_static/custom.css
@@ -1,5 +1,5 @@
-/* This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
- * DO NOT EDIT.
+/* {{ cookiecutter.generated_file_header }}
+ * {{ cookiecutter.dont_edit_header }}
  */
 
 /* Missing style for nodes.system_message from Alabaster. */
diff --git a/{{cookiecutter.name}}/docs/changelog.rst b/{{cookiecutter.name}}/docs/changelog.rst
@@ -1,5 +1,4 @@
-.. This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+.. {{ cookiecutter.generated_file_header }}
 
 ==========
 Change Log
diff --git a/{{cookiecutter.name}}/docs/conf.py b/{{cookiecutter.name}}/docs/conf.py
@@ -1,5 +1,4 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+# {{ cookiecutter.generated_file_header }}
 
 # Configuration file for the Sphinx documentation builder.
 #
diff --git a/{{cookiecutter.name}}/docs/index.rst b/{{cookiecutter.name}}/docs/index.rst
@@ -1,5 +1,4 @@
-.. This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+.. {{ cookiecutter.generated_file_header }}
 
 {% for _ in cookiecutter.full_name %}={% endfor %}
 {{ cookiecutter.full_name }}
diff --git a/{{cookiecutter.name}}/docs/make.bat b/{{cookiecutter.name}}/docs/make.bat
@@ -1,6 +1,7 @@
-REM This file is generated from {{ cookiecutter.github_owner }}/cookiecutter. DO NOT EDIT.
-
-@ECHO OFF
+REM {{ cookiecutter.generated_file_header }}
+REM {{ cookiecutter.dont_edit_header }}
+
+@ECHO OFF
 
 pushd %~dp0
 
diff --git a/{{cookiecutter.name}}/pyproject.toml b/{{cookiecutter.name}}/pyproject.toml
@@ -1,5 +1,4 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+# {{ cookiecutter.generated_file_header }}
 
 # This file is used to configure your project.
 # Read more about the various options under:
diff --git a/{{cookiecutter.name}}/ruff.toml b/{{cookiecutter.name}}/ruff.toml
@@ -1,5 +1,4 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# You need to consider modifying the TEMPLATE or modifying THIS FILE.
+# {{ cookiecutter.generated_file_header }}
 
 exclude = [
     "docs/conf.py",
diff --git a/{{cookiecutter.name}}/src/{{cookiecutter.namespace}}/{{cookiecutter.name}}/meta.py b/{{cookiecutter.name}}/src/{{cookiecutter.namespace}}/{{cookiecutter.name}}/meta.py
@@ -1,5 +1,5 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# DO NOT EDIT!!!
+# {{ cookiecutter.generated_file_header }}
+# {{ cookiecutter.dont_edit_header }}
 
 ################################################################################
 # Project meta infos.
diff --git a/{{cookiecutter.name}}/tests/__init__.py b/{{cookiecutter.name}}/tests/__init__.py
@@ -0,0 +1 @@
+# {{ cookiecutter.generated_file_header }}
diff --git a/{{cookiecutter.name}}/tests/test_always_pass.py b/{{cookiecutter.name}}/tests/test_always_pass.py
@@ -1,5 +1,5 @@
-# This file is generated from {{ cookiecutter.github_owner }}/cookiecutter.
-# DO NOT EDIT.
+# {{ cookiecutter.generated_file_header }}
+# {{ cookiecutter.dont_edit_header }}
 
 import unittest
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`name: Ruff`
`2`	`4`	`on: [ push, pull_request ]`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`name: Deploy Sphinx documentation to Pages`
`2`	`4`
`3`	`5`	`# Runs on pushes targeting the default branch`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`name: Publish package distributions to PyPI`
`2`	`4`
`3`	`5`	`on:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`name: Publish Github Release`
`2`	`4`
`3`	`5`	`on:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`name: Test`
`2`	`4`	`on:`
`3`	`5`	`push:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`# Byte-compiled / optimized / DLL files`
`2`	`4`	`__pycache__/`
`3`	`5`	`*.py[cod]`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# {{ cookiecutter.generated_file_header }}`
	`2`	`+`
`1`	`3`	`repos:`
`2`	`4`	`- repo: https://github.com/astral-sh/ruff-pre-commit`
`3`	`5`	`rev: v0.14.11`