TOC generation with git hooks #720
Merged
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
added 2 commits
January 21, 2022 11:38
Signed-off-by: juan131 <juanariza@vmware.com>
Signed-off-by: juan131 <juanariza@vmware.com>
added 2 commits
January 21, 2022 11:48
Signed-off-by: juan131 <juanariza@vmware.com>
Signed-off-by: juan131 <juanariza@vmware.com>
agarcia-oss
approved these changes
Jan 21, 2022
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.
Signed-off-by: juan131 juanariza@vmware.com
Description of the change
We recently enabled branch protection rules for the "main" branch. As a result, the TOC Generator hook is failing with the error below:
The current TOC Generator hook only allows to push commits when it's triggered by a "push event" (this is what happens after merging a PR), therefore is no longer valid for us. As an alternative, we can use git-hooks to update the TOC before committing changes affecting
.mdand.txtfiles.Benefits
README.md's TOC is autogenerated.
Possible drawbacks
Users need to instal git-hooks and doctoc locally to modify the README.md.
Applicable issues
N/A
Additional information
N/A