Skip to content

docs(envvars): Automatically update environment files#218

Merged
samoehlert merged 11 commits intomainfrom
topic/soehlert/env_var_documentation
Apr 29, 2026
Merged

docs(envvars): Automatically update environment files#218
samoehlert merged 11 commits intomainfrom
topic/soehlert/env_var_documentation

Conversation

@samoehlert
Copy link
Copy Markdown
Collaborator

Closes #81

This includes:

  • a script to parse environment variables (a bit of a nasty regex, I'm not sure how else to do it)
  • associated tests
  • the docs themselves
  • convenience Makefile target
  • precommit hook that runs the Makefile target so each commit theoretically has the latest variable CRUDs
  • finally precommit was upset at me for not having the python-version

Also ruff formatting changed a couple of whitespace things, whatever.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 27, 2026

Pytest Celery Scheduler Coverage

File Coverage
All files 100%

Minimum allowed coverage is 80%

Generated by 🐒 cobertura-action against ae2e8c6

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 27, 2026

Django Pytest/Behave Coverage

File Coverage
All files 78%
config/consumers.py 60%
config/urls.py 69%
config/settings/base.py 69%
config/settings/local.py 72%
scram/route_manager/admin.py 71%
scram/route_manager/models.py 79%
scram/route_manager/views.py 88%
scram/route_manager/api/serializers.py 92%
scram/route_manager/api/views.py 63%
scram/shared/shared_code.py 56%
scram/templates/403.html 91%
scram/templates/404.html 91%
scram/templates/base.html 99%

Minimum allowed coverage is 50%

Generated by 🐒 cobertura-action against ae2e8c6

Copy link
Copy Markdown
Collaborator

@crankynetman crankynetman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just a few comments, mostly minor stuff. Nicely done, this is going to be a huge help for QoL.

Comment thread Makefile
Comment thread scripts/tests/test_extract_env_vars.py Outdated
Comment thread docs/environment_variables.md Outdated
Comment thread docs/environment_variables.md Outdated
Comment thread scripts/extract_env_vars.py Outdated
Comment thread pyproject.toml
Comment thread scripts/extract_env_vars.py Outdated
Copy link
Copy Markdown
Collaborator

@crankynetman crankynetman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome, well done!

@samoehlert samoehlert merged commit 28ad822 into main Apr 29, 2026
18 of 20 checks passed
@samoehlert samoehlert deleted the topic/soehlert/env_var_documentation branch April 29, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the required environment variables as well as their defaults

2 participants