(PUP-12065) Add task to generate configuration reference #9459
Conversation
This file contains 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
bundle exec rake references:configuration
It runs `puppet doc -r configuration` to generate references/configuration.md.
In order for the output to not be dependent on the hostname/domain facts, allow
them to be overridden as an environment variable. This can't be done using
FACTER_*, because structured facts like `networking.hostname` can't be overridden
by an env variable.
To determine if any meaningful changes have been made, you can run:
git diff -I built_from_commit -I 'This page was generated from the Puppet source code' references/
mhashizume
approved these changes
Aug 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.
It runs
puppet doc -r configurationto generate references/configuration.md.In order for the output to not be dependent on the hostname/domain facts, allow them to be overridden as an environment variable. This can't be done using FACTER_*, because structured facts like
networking.hostnamecan't be overridden by an env variable.To determine if any meaningful changes have been made, you can run: