-
Notifications
You must be signed in to change notification settings - Fork 5
docs: auto generate markdown files #441
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
Merged
Merged
Conversation
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
mkilpatrick
reviewed
Nov 16, 2023
mkilpatrick
reviewed
Nov 16, 2023
packages/pages/docs/api/pages.clientserverrendertemplates.iscustomrendertemplate.md
Outdated
Show resolved
Hide resolved
d2f803d
to
9041c67
Compare
06b30d6
to
8b2d073
Compare
mkilpatrick
reviewed
Nov 17, 2023
mkilpatrick
approved these changes
Nov 22, 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.
This commit adds a new workflow, generate markdown files, which runs api-extractor and api-documenter in order to generate markdown files for all the @public functions in our src code.
There is now a bot that auto runs tests after the generate markdown file workflow and check + update 3rd party notices workflow.
How the bot works:
The bot has write access to the repo, so it is like a regular user committed to the repo, rather than an automated commit. GH prevents automated commits from a workflow, which uses the GITHUB_TOKEN by default, from re-running checks (b/c it might cause an infinite loop of GH actions running), but commits from a workflow with a personal access token will trigger a re-run of tests. so, in a way we're bypassing some of the built-in GH protections, so we have to be careful to only use the bot token in a repo when we know for sure that it won't create an infinite loop of GH workflow triggering.