Automatically update readme anchors with doctoc #4906
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
fchatterji
requested review from
compwron,
FireLemons and
littleforest
as code owners
compwron
reviewed
Jun 28, 2023
| name: TOC Generator | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: technote-space/toc-generator@v4 |
There was a problem hiding this comment.
compwron
approved these changes
Jun 28, 2023
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.
What github issue is this PR for, if any?
Resolves #2516
What changed, and why?
Added a yml file to configure the doctoc github action
Automatically updated the readme table of content on push
Note: the github token used by the bot needs to be correctly configured for it to work (needs write permission or maybe a github token, see https://github.com/marketplace/actions/toc-generator for more details). It works on my repo, I don't know if it will work on casa
How will this affect user permissions?
How is this tested? (please write tests!) 💖💪
No tests, i saw it work on my local repo
Screenshots please :)
Feelings gif (optional)
What gif best describes your feeling working on this issue? https://giphy.com/
How to embed:
Feedback please? (optional)
We are very interested in your feedback! Please give us some :) https://forms.gle/1D5ACNgTs2u9gSdh9