Conversation
Contributor
|
Hrmm, I like it. My only concern is keeping it up to date. I can't find a I do this with proto gen today. And I have already marked one matrix run as # Confirm README ToC is generated properly
- name: Check generated README ToC
if: ${{ matrix.docsTarget }}
run: |
npx doctoc README.md
[[ -z $(git status --porcelain README.md) ]] || (git diff README.md; echo "README changed"; exit 1)(ideally node install would either be same step or at least right near it with same conditional...feel free to push a known failure to confirm the check works before pushing the proper) |
Contributor
Author
|
Confirming that the new step fails as expected: build-lint-test (3.11, ubuntu-latest) Now fixing so it'll pass |
This reverts commit 0291f4c.
cretz
approved these changes
Nov 21, 2022
cretz
left a comment
Contributor
There was a problem hiding this comment.
Thanks! Will merge once CI completes.
| if: ${{ github.ref == 'refs/heads/main' && matrix.docsTarget }} | ||
| run: npx vercel deploy build/apidocs -t ${{ secrets.VERCEL_TOKEN }} --name python --scope temporal --prod --yes | ||
|
|
||
| # Confirm README ToC is generated properly |
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
2 participants
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.
I like these, for helping people know what content it has, and easily jumping to a specific thing. While there is a built-in button, many don't know of it, and it's harder to get a sense of everything because it's small and scrolling.
Updatable either manually or with
npx doctoc README.md