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

chore: Add test to make sure flags are up to date and sorted #4845

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lukemassa
Copy link
Contributor

@lukemassa lukemassa commented Aug 15, 2024

what

Add a unit test to make sure that the flags in the server-configuration.md page in the documentation match the configuration options, and are sorted in the file.

Additionally added documentation for two missing flags --disable-global-apply-lock and --disable-markdown-folding, and reordered a few that were out of order.

why

Important to make sure all our flags are documented (and the disabled flags are removed). Also might as well keep them sorted.

tests

Just running the unit tests

references

Followup from #4063

@lukemassa lukemassa requested review from a team as code owners August 15, 2024 03:17
@lukemassa lukemassa requested review from chenrui333, nitrocode and X-Guardian and removed request for a team August 15, 2024 03:17
@github-actions github-actions bot added docs Documentation go Pull requests that update Go code labels Aug 15, 2024
Copy link
Contributor

@jamengual jamengual left a comment

Choose a reason for hiding this comment

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

nice work on the flag and doc tests, this is cool.

@X-Guardian
Copy link
Contributor

@lukemassa, can I get this merged?

@X-Guardian X-Guardian added the waiting-on-response Waiting for a response from the user label Nov 2, 2024
@lukemassa lukemassa enabled auto-merge (squash) November 5, 2024 14:47
@lukemassa lukemassa force-pushed the make_sure_documentation_flags_are_up_to_date branch from 8a72b59 to 2e87ffa Compare November 5, 2024 14:48
@X-Guardian
Copy link
Contributor

Hi @lukemassa, the tests and Website Link checks are failing on this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation go Pull requests that update Go code waiting-on-response Waiting for a response from the user
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants