Improved templating audits

[kenodegard]

Description

Depends on #243

Whoa this became kinda complicated...no wonder I originally skipped this stuff.

I was reminded (in conda/conda-libmamba-solver#588 (comment)) that I had chosen not to over engineered the templating engine but with the templates becoming more complex (and others besides myself monitoring the templating jobs) we might as well include all the bells and whistles to help ourselves when debugging.

Old Audit
New Audit

This change introduces a few key improvements:

1. we now watch for context usage so we can warn the user about missing variables, the context has 4 possible states:

   State	Description
   	a variable that has been successfully used in the template
   	a variable that has not been defined but has a fallback value in the template
   	a variable that has not been defined and has no fallback value
   	a variable that is not used in the template

2. if the templating produces errors we will leave the audit open by default, this will make the errors more noticeable

3. the template stubs table also includes counts of how many times the stubs are referenced

[kenodegard]

pre-commit/ruff changes

[travishathaway]

@kenodegard,

Maybe a little outside the scope of this pull request, but why isn't the code in this repository being tested? 😅

If you could, maybe now would be a good time to introduce it if only for this code that is changing in this pull request.

[travishathaway]

I created a separate issue for adding a testing actions:

• Add an action to run tests as part of pull requests (and some trivial "starter" tests) #242

[kenodegard]

Maybe a little outside the scope of this pull request, but why isn't the code in this repository being tested? 😅

GitHub Actions/Workflows are not exactly easy to test in many cases since they're always running in "production", this GHA is probably an easier one to test since the action defers to a standalone script, but yes it would be good to figure something out testing wise

[github-actions]

Template Success

Templating Audit

• 🔄 Fetching files from ./templates
  • ✅ file1.txt → .github_cache/template-files/success/file1.txt
    • ✅ (used) stub1.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
  • ⚠️ file2.txt → .github_cache/template-files/success/file2.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
    • 📚 (context) variable=value
    • ➕ (optional) optional=

Stub	State	Count
stub1.txt	✅ (used)	1
stub2.txt	✅ (used)	2
stub3.txt	❌ (missing)	2

Template Error

Templating Audit

• 🔄 Fetching files from ./templates
  • ✅ file1.txt → .github_cache/template-files/error/file1.txt
    • ✅ (used) stub1.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
  • ❌ Context missing file2.txt → .github_cache/template-files/error/file2.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
    • ❌ (missing) variable=
    • ➕ (optional) optional=

Stub	State	Count
stub1.txt	✅ (used)	1
stub2.txt	✅ (used)	2
stub3.txt	❌ (missing)	2

Got 1 error(s)

[conda-bot]

Template Success

Warning

This is what the audit looks like when the templating has no errors.

Templating Audit

• 🔄 Fetching files from ./templates
  • ✅ file1.txt → .github_cache/template-files/success/file1.txt
    • ✅ (used) stub1.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
  • ⚠️ file2.txt → .github_cache/template-files/success/file2.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
    • 📚 (context) variable=value
    • ➕ (optional) optional=

Stub	State	Count
stub1.txt	✅ (used)	1
stub2.txt	✅ (used)	2
stub3.txt	❌ (missing)	2

### Template Error > [!WARNING] > This is what the audit looks like when templating results in errors.

Templating Audit

• 🔄 Fetching files from ./templates
  • ✅ file1.txt → .github_cache/template-files/error/file1.txt
    • ✅ (used) stub1.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
  • ❌ Context missing file2.txt → .github_cache/template-files/error/file2.txt
    • ✅ (used) stub2.txt
    • ❌ (missing) stub3.txt
    • ❌ (missing) variable=
    • ➕ (optional) optional=

Stub	State	Count
stub1.txt	✅ (used)	1
stub2.txt	✅ (used)	2
stub3.txt	❌ (missing)	2

Got 1 error(s)