Skip to content

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 10 commits into from
Nov 22, 2023
Merged

docs: auto generate markdown files #441

merged 10 commits into from
Nov 22, 2023

Conversation

asanehisa
Copy link
Contributor

@asanehisa asanehisa commented Nov 16, 2023

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.

@asanehisa asanehisa requested a review from a team as a code owner November 16, 2023 16:08
@asanehisa asanehisa marked this pull request as draft November 16, 2023 16:08
@asanehisa asanehisa marked this pull request as ready for review November 17, 2023 18:28
@asanehisa asanehisa changed the title feat: auto generate markdown files docs: auto generate markdown files Nov 22, 2023
@asanehisa asanehisa merged commit 70a25be into main Nov 22, 2023
@asanehisa asanehisa deleted the add-github-action branch November 22, 2023 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants