feat: auto add flags docs into the README #147
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matifali
reviewed
Apr 25, 2024
matifali
reviewed
Apr 25, 2024
dannykopping
approved these changes
Apr 26, 2024
mafredri
reviewed
Apr 26, 2024
mafredri
reviewed
Apr 26, 2024
bfaff9c to
1607f13
Compare
1607f13 to
e292feb
Compare
matifali
approved these changes
Apr 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I still need to make it run on CI and add it to Makefile but I would appreciate an early review of the code.
You can see a preview of the generated docs here: https://github.com/coder/envbuilder/blob/cd219d378179f0861903190dcd66c117dcc8dd68/README.md#environment-variables
Strategy
I added some markers, as HTML comments, in the markdown so the script can know where to place/replace the new content. Another option is to create another markdown file only for the flags and mention it on the main README.
Close #130