diff --git a/template/.dockerignore b/template/.dockerignore index 7fd788f8..dbb72741 100644 --- a/template/.dockerignore +++ b/template/.dockerignore @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + debug/ target/ **/*.rs.bk diff --git a/template/.envrc.sample b/template/.envrc.sample index 247153c0..6a2a188c 100644 --- a/template/.envrc.sample +++ b/template/.envrc.sample @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + # vim: syntax=conf # # If you use direnv, you can autoload the nix shell: diff --git a/template/.gitattributes b/template/.gitattributes index 53c7506b..7528684c 100644 --- a/template/.gitattributes +++ b/template/.gitattributes @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + nix/** linguist-generated Cargo.nix linguist-generated crate-hashes.json linguist-generated diff --git a/template/.github/ISSUE_TEMPLATE/01-normal-issue.md b/template/.github/ISSUE_TEMPLATE/01-normal-issue.md index 61e46c8c..26255642 100644 --- a/template/.github/ISSUE_TEMPLATE/01-normal-issue.md +++ b/template/.github/ISSUE_TEMPLATE/01-normal-issue.md @@ -1,3 +1,8 @@ + + --- name: Normal issue about: This is just a normal empty issue with a simple checklist diff --git a/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 b/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 index 6a78858f..0a344a9a 100644 --- a/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 +++ b/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- name: "🐛 Bug Report" description: "If something isn't working as expected 🤔." diff --git a/template/.github/ISSUE_TEMPLATE/config.yml.j2 b/template/.github/ISSUE_TEMPLATE/config.yml.j2 index 361086a8..99c79ee3 100644 --- a/template/.github/ISSUE_TEMPLATE/config.yml.j2 +++ b/template/.github/ISSUE_TEMPLATE/config.yml.j2 @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- blank_issues_enabled: true contact_links: diff --git a/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md b/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md index bc008c91..d1453d29 100644 --- a/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md +++ b/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md @@ -1,3 +1,8 @@ + + ## Check and Update Getting Started Script + ## Bump Rust Dependencies for Stackable Release YY.M.X + ## Description *Please add a description here. This will become the commit message of the merge request later.* diff --git a/template/.github/workflows/integration-test-custom.yaml b/template/.github/workflows/integration-test-custom.yaml index 8d6e8483..d933b5e9 100644 --- a/template/.github/workflows/integration-test-custom.yaml +++ b/template/.github/workflows/integration-test-custom.yaml @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- name: Integration Test (Custom) diff --git a/template/.github/workflows/integration-test-profile.yaml b/template/.github/workflows/integration-test-profile.yaml index a4c55ca9..81b38740 100644 --- a/template/.github/workflows/integration-test-profile.yaml +++ b/template/.github/workflows/integration-test-profile.yaml @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- name: Integration Test (Profile + Schedule) diff --git a/template/.github/workflows/pr_prek.yaml.j2 b/template/.github/workflows/pr_prek.yaml.j2 index ce6f49e8..4ce5f5a1 100644 --- a/template/.github/workflows/pr_prek.yaml.j2 +++ b/template/.github/workflows/pr_prek.yaml.j2 @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- name: prek diff --git a/template/.gitignore.j2 b/template/.gitignore.j2 index 696bc411..411cc85d 100644 --- a/template/.gitignore.j2 +++ b/template/.gitignore.j2 @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + tests/_work/ debug/ target/ diff --git a/template/.hadolint.yaml b/template/.hadolint.yaml index 0e9084e7..e27b31bc 100644 --- a/template/.hadolint.yaml +++ b/template/.hadolint.yaml @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- ignored: # Warning: Use the -y switch to avoid manual input dnf install -y diff --git a/template/.markdownlint.yaml b/template/.markdownlint.yaml index 75212ec5..9befea53 100644 --- a/template/.markdownlint.yaml +++ b/template/.markdownlint.yaml @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- # All defaults or options can be checked here: # https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml diff --git a/template/.pre-commit-config.yaml.j2 b/template/.pre-commit-config.yaml.j2 index 9b181f8a..cf2fbc81 100644 --- a/template/.pre-commit-config.yaml.j2 +++ b/template/.pre-commit-config.yaml.j2 @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- exclude: ^(Cargo\.nix|crate-hashes\.json|nix/.*)$ diff --git a/template/.pylintrc b/template/.pylintrc index 5df27e82..ff87cc9c 100644 --- a/template/.pylintrc +++ b/template/.pylintrc @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + [MESSAGES CONTROL] # These rules are for missing docstrings which doesn't matter much for most of our simple scripts diff --git a/template/.vscode/DO_NOT_EDIT.md b/template/.vscode/DO_NOT_EDIT.md new file mode 100644 index 00000000..642bbc7f --- /dev/null +++ b/template/.vscode/DO_NOT_EDIT.md @@ -0,0 +1,9 @@ +# DO NOT EDIT + +The files in this directory are automatically generated from the templates in stackabletech/operator-templating + +DO NOT MANUALLY EDIT THESE FILES + +> [!NOTE] +> This file only exists because VS Code currently doesn't support JSONC files. +> See diff --git a/template/.yamllint.yaml b/template/.yamllint.yaml index 020cb5f0..f8970d15 100644 --- a/template/.yamllint.yaml +++ b/template/.yamllint.yaml @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- extends: default diff --git a/template/Tiltfile.j2 b/template/Tiltfile.j2 index 826d23bf..8502efed 100644 --- a/template/Tiltfile.j2 +++ b/template/Tiltfile.j2 @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + # Load the metadata first, so that we immediately get access to the operator name meta = read_json('nix/meta.json') operator_name = meta['operator']['name'] diff --git a/template/deny.toml b/template/deny.toml index f446cc19..089f738b 100644 --- a/template/deny.toml +++ b/template/deny.toml @@ -1,6 +1,9 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + # This file is the source of truth for all our repos! # This includes repos not templated by operator-templating, please copy/paste the file for this repos. - +# # TIP: Use "cargo deny check" to check if everything is fine [graph] diff --git a/template/nix/sources.nix b/template/nix/sources.nix index fe3dadf7..07aa2576 100644 --- a/template/nix/sources.nix +++ b/template/nix/sources.nix @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE +# # This file has been generated by Niv. let diff --git a/template/rust-toolchain.toml.j2 b/template/rust-toolchain.toml.j2 index 450cfa9f..040307e5 100644 --- a/template/rust-toolchain.toml.j2 +++ b/template/rust-toolchain.toml.j2 @@ -1,4 +1,6 @@ -# DO NOT EDIT, this file is generated by operator-templating +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + [toolchain] channel = "{[ rust_version }]" profile = "default" diff --git a/template/rustfmt.toml.j2 b/template/rustfmt.toml.j2 index be99492b..3b7624ad 100644 --- a/template/rustfmt.toml.j2 +++ b/template/rustfmt.toml.j2 @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + # This file includes unstable features, so you need to run "cargo +nightly fmt" to format your code. # It's also ok to use the stable toolchain by simple running "cargo fmt", but using the nightly formatter is preferred. diff --git a/template/scripts/auto-retry-tests.py b/template/scripts/auto-retry-tests.py index 153b7fc1..2ee829d6 100755 --- a/template/scripts/auto-retry-tests.py +++ b/template/scripts/auto-retry-tests.py @@ -1,4 +1,8 @@ #!/usr/bin/env python3 + +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + """ Automated test suite runner with intelligent retry logic for flaky integration tests. diff --git a/template/scripts/docs_templating.sh.j2 b/template/scripts/docs_templating.sh.j2 index 4735410f..e38d43cb 100755 --- a/template/scripts/docs_templating.sh.j2 +++ b/template/scripts/docs_templating.sh.j2 @@ -1,4 +1,8 @@ #!/usr/bin/env bash + +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + set -euo pipefail # Reads a file with variables to insert into templates, and templates all .*.j2 files diff --git a/template/scripts/ensure_one_trailing_newline.py b/template/scripts/ensure_one_trailing_newline.py index a6f73c06..6f57b91f 100644 --- a/template/scripts/ensure_one_trailing_newline.py +++ b/template/scripts/ensure_one_trailing_newline.py @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + """ Given the location of a file, trims all trailing blank lines and places a single one. Used as post-processing step for README rendering. diff --git a/template/scripts/render_readme.sh b/template/scripts/render_readme.sh index 78489c24..048dff33 100755 --- a/template/scripts/render_readme.sh +++ b/template/scripts/render_readme.sh @@ -1,4 +1,8 @@ #!/usr/bin/env bash + +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + set -euo pipefail # Check if jinja2 is there diff --git a/template/scripts/run-tests b/template/scripts/run-tests index 4e6496b5..ea149d79 100755 --- a/template/scripts/run-tests +++ b/template/scripts/run-tests @@ -1,6 +1,9 @@ #!/usr/bin/env python # vim: filetype=python syntax=python tabstop=4 expandtab +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + import argparse import collections.abc import contextlib diff --git a/template/scripts/run_tests.sh b/template/scripts/run_tests.sh index a31a1382..c41c4c7d 100755 --- a/template/scripts/run_tests.sh +++ b/template/scripts/run_tests.sh @@ -1,3 +1,6 @@ #!/usr/bin/env bash +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + ./scripts/run-tests "$@" diff --git a/template/shell.nix b/template/shell.nix index b6ee3afb..890b25c1 100644 --- a/template/shell.nix +++ b/template/shell.nix @@ -1,3 +1,6 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE + let self = import ./. {}; inherit (self) sources pkgs meta; diff --git a/template/tests/README-templating.md b/template/tests/README-templating.md index 8da9fe91..7f05d504 100644 --- a/template/tests/README-templating.md +++ b/template/tests/README-templating.md @@ -1,3 +1,8 @@ + + # Test Scenario Templating ## Introduction diff --git a/template/tests/kuttl-test.yaml.jinja2 b/template/tests/kuttl-test.yaml.jinja2 index 8a5620c4..4366670a 100644 --- a/template/tests/kuttl-test.yaml.jinja2 +++ b/template/tests/kuttl-test.yaml.jinja2 @@ -1,3 +1,5 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE --- apiVersion: kuttl.dev/v1beta1 kind: TestSuite diff --git a/template/tests/templates/.gitkeep b/template/tests/templates/.gitkeep index e69de29b..d20cec98 100644 --- a/template/tests/templates/.gitkeep +++ b/template/tests/templates/.gitkeep @@ -0,0 +1,2 @@ +# This file is automatically generated from the templates in stackabletech/operator-templating +# DO NOT MANUALLY EDIT THIS FILE