Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 [open-zaak/open-zaak#1649] Document envvars #19

Merged
merged 3 commits into from
Aug 22, 2024

Conversation

stevenbal
Copy link
Contributor

@stevenbal stevenbal commented Jul 23, 2024

Fixes open-zaak/open-zaak#1649 partially

Changes

  • Document the envvars
  • Add CI job to check if envvar docs were updated

@codecov-commenter
Copy link

codecov-commenter commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.20%. Comparing base (8d6e36c) to head (84c7547).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #19   +/-   ##
=======================================
  Coverage   92.20%   92.20%           
=======================================
  Files          53       53           
  Lines        1039     1039           
=======================================
  Hits          958      958           
  Misses         81       81           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stevenbal stevenbal force-pushed the feature/envvar-documentation branch from db0cbdd to 3fe4395 Compare July 23, 2024 13:53
@stevenbal stevenbal changed the title Feature/envvar documentation 📝 [open-zaak/open-zaak#1649] Document envvars Jul 23, 2024
@stevenbal stevenbal force-pushed the feature/envvar-documentation branch from 3fe4395 to 84c7547 Compare July 23, 2024 14:16
@stevenbal stevenbal marked this pull request as draft July 23, 2024 15:04
@stevenbal stevenbal force-pushed the feature/envvar-documentation branch from 84c7547 to ebf1220 Compare August 16, 2024 11:29
replace the manual envvar docs with OAf `generate_envvar_docs`, this ensure that generic envvars that are used by every component are documented centrally in OAF and custom envvars can be documented in the code where they are declared
@stevenbal stevenbal force-pushed the feature/envvar-documentation branch from ebf1220 to bfc0e1c Compare August 16, 2024 11:30
@stevenbal stevenbal marked this pull request as ready for review August 16, 2024 11:30
@stevenbal stevenbal merged commit 29a84b0 into master Aug 22, 2024
10 checks passed
@stevenbal stevenbal deleted the feature/envvar-documentation branch August 22, 2024 12:17
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.

Automatically generate documentation from environment variables
4 participants