-
Notifications
You must be signed in to change notification settings - Fork 652
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
Keep configuration.md
file in sync with the changes in code
#4104
Conversation
configuration.md
file in sync with the changes in code
da65ea6
to
a3ed70a
Compare
If the configuration for a workflow will change the unit test will fail and will require to accept the new changes. These changes are then copied to the docs
Hi @arturcic. Thank you that you are going to fix this. We have at the moment three sources right?
Is your plan to consolidate all three sources into one? |
Yes, that is part of this PR ConfigurationBuilder - is the primary source, the rest gets updated. ConfigurationBuilder -> docs/input/docs/workflows/ (via Copy files from approved folder) |
Very well. Good work. :) |
Thank you @arturcic for your contribution! |
Closes #4017
In this PR I made it possible that whenever the workflow configuration changes, it gets also synced with the
configuration.md
file.This is the way it is achieved:
CheckWorkflowsAreUpdated
that creates a new Configuration for the workflow and check if the serialized version matches the approved version. If not, then you need to accept the new changes and run again the test.dotnet build
is performed, theapproved
files are copied to the docs (synced)mkdocs.yml
, that embeds the changes intoconfiguration.md
using the MarkdownSnippets.Tool.This tool takes a
*.source.md
file as input and embeds the content of the file similar toThe
*.source.md
file is located in amdsource
folder and excluded on docs publishing. (mdsource-directory)The new updated result file is committed and pushed by the GitHub Action.
The nice thing about the embedding is that the tools also adds nice links similar to