Skip to content
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

Merged
merged 14 commits into from
Dec 7, 2024

Conversation

erickzhao
Copy link
Member

@erickzhao erickzhao commented Nov 15, 2024

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

@erickzhao erickzhao marked this pull request as ready for review November 15, 2024 20:35
@erickzhao erickzhao requested a review from a team as a code owner November 15, 2024 20:35
@erickzhao erickzhao marked this pull request as draft November 15, 2024 20:35
@erickzhao erickzhao changed the title build: publish API documentaiton build: publish API documentation Nov 15, 2024
@erickzhao erickzhao closed this Nov 15, 2024
@erickzhao erickzhao reopened this Nov 15, 2024
@erickzhao erickzhao marked this pull request as ready for review November 30, 2024 00:21
@erickzhao erickzhao marked this pull request as draft November 30, 2024 00:22
@erickzhao erickzhao marked this pull request as ready for review December 3, 2024 04:04
Copy link
Member

@VerteDinde VerteDinde left a 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!

.github/workflows/docs.yml Outdated Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
Copy link
Member

@MarshallOfSound MarshallOfSound left a 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

.github/workflows/docs.yml Outdated Show resolved Hide resolved
workflow_dispatch:
push:
tags:
- v[0-9]+.[0-9]+.[0-9]+*
Copy link
Member

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?

Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Member

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 👍

.github/workflows/docs.yml Outdated Show resolved Hide resolved
@erickzhao erickzhao merged commit 45230c6 into electron:main Dec 7, 2024
6 checks passed
@erickzhao erickzhao deleted the build/docs-website-action branch December 7, 2024 00:46
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.

4 participants