-
Notifications
You must be signed in to change notification settings - Fork 33
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
build: publish API documentation #217
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two non-blocking comments, in general this looks good to me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code seems good, two infra security questions
workflow_dispatch: | ||
push: | ||
tags: | ||
- v[0-9]+.[0-9]+.[0-9]+* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we confirm tags are protected on this repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also limit the secrets to an environment which is restricted to these tags.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have access to the exact rulesets without admin permissions but I am unable to delete tags via the GitHub UI so I'm guessing yes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the secrets to the publish-docs
env, we should be good to go here 👍
Co-authored-by: David Sanders <[email protected]>
Adds a GitHub Action to generate TypeDoc API documentation and upload it to Azure Blob Storage with an SAS token.
See example run on my fork: https://github.com/erickzhao/notarize/actions/runs/11863393596/job/33064761419