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

test: check flag/docs consistency #1770

Merged
merged 3 commits into from
Sep 16, 2023
Merged

test: check flag/docs consistency #1770

merged 3 commits into from
Sep 16, 2023

Conversation

piksel
Copy link
Member

@piksel piksel commented Sep 16, 2023

This PR adds a test that check whether the flags specified in the code matches the ones in the docs. If either a ENVIRONMENT_VARIABLE or a --argument is not mentioned in the docs it will cause the test to fail.

Note: intentionally pushing the first version of this PR with missing docs.

@codecov
Copy link

codecov bot commented Sep 16, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.20% 🎉

Comparison is base (36391b0) 67.60% compared to head (39547ff) 67.80%.
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1770      +/-   ##
==========================================
+ Coverage   67.60%   67.80%   +0.20%     
==========================================
  Files          26       26              
  Lines        2380     2395      +15     
==========================================
+ Hits         1609     1624      +15     
  Misses        672      672              
  Partials       99       99              
Files Changed Coverage Δ
internal/flags/flags.go 85.61% <100.00%> (+0.40%) ⬆️

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

@piksel piksel merged commit 1d5a8d9 into main Sep 16, 2023
11 checks passed
@piksel piksel deleted the fix/flag-docs branch September 16, 2023 15:04
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.

1 participant