Skip to content

[main] enable auto doc generation #2410

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.

Sign up for GitHub

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
siyuniu-ms merged 4 commits into from
Sep 11, 2024
Merged

[main] enable auto doc generation #2410

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26c4af0
Update jekyll-gh-pages.yml
siyuniu-ms Sep 11, 2024
0489159
Merge branch 'main' into siyu/docUpdate
siyuniu-ms Sep 11, 2024
cd2c5d1
add branch
siyuniu-ms Sep 11, 2024
1d542c4
Update jekyll-gh-pages.yml
siyuniu-ms Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/jekyll-gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ jobs:
- run: node common/scripts/install-run-rush.js install
- run: npm run build --verbose
timeout-minutes: 20
- name: doc generate
Copy link
Collaborator

@MSNev MSNev Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see...
So at the point that this action "runs" which should be triggered by the "checkin" (please correct me if I'm wrong) we not only "decorate" the pages here but actually "generate them -- nice!

Copy link
Collaborator

@MSNev MSNev Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI - in github "Authorization" of an action based on the branch name is at the top of the file

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

and is not part of the "Internal" authorization process

Copy link
Contributor Author

@siyuniu-ms siyuniu-ms Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems to be the branches that could auto trigger the run, but didn't give the access of publish the doc

run: npm run api-docs
- name: Inject Script
run: node ./tools/github-page-script-injection/injectScript.js
- name: Setup Pages
Expand Down