Fix for #128: Documentation enhancement for Github Actions#129
Merged
ekalinin merged 1 commit intoekalinin:masterfrom Mar 26, 2022
Merged
Conversation
Owner
|
Thanks! |
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
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.
Hi,
this PR enhances the example for use of this project with Github Actions. The problems I faced when I copy and pasted the example into my Github Action are described in issue #128.
Adding the
--hide-footerflag makes sure that no unnecessary auto-commit is generated by the Gitub Action. For example, if you were to change the content offoo.md, but would leave the structure of its headlines intact, there is no need to generate a new TOC.gh-md-tocadds afootercomment to your TOC that reads something like<!-- Created by <user> at <datetime> -->. This changes every timegh-md-tocis executed at a differentdatetime. Hiding the footer makes runninggh-md-tocidempotent, if the headers infoo.mddo not change. This removes auto-commits by the Github Action even when the TOC does not change.Adding the
rm gh-md-tocline to the action removes thegh-md-tocscript from the repository again, so it won't be added to the repo by the auto-commit of the Github Action.