-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
auto-gen api reports and docs
- Loading branch information
Showing
35 changed files
with
2,584 additions
and
21 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
name: Documentation | ||
|
||
on: | ||
push: | ||
branches: [develop] | ||
|
||
permissions: | ||
id-token: write | ||
pages: write | ||
contents: write | ||
packages: write | ||
|
||
jobs: | ||
publish-docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Install pnpm | ||
uses: pnpm/action-setup@v4 | ||
|
||
- run: corepack enable | ||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: lts/* | ||
cache: pnpm | ||
registry-url: "https://registry.npmjs.org/" | ||
scope: "@opengovsg" | ||
|
||
- name: Install Dependencies | ||
run: | | ||
pnpm i --frozen-lockfile | ||
npm install -g @microsoft/api-documenter | ||
npm install -g @microsoft/api-extractor | ||
- name: Check API report | ||
run: pnpm ci:report | ||
|
||
- name: Generate documentation | ||
run: pnpm build:docs | ||
|
||
- name: Upload to GitHub Pages | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: apps/docs/.vitepress/dist | ||
|
||
- name: Deploy to GitHub Pages | ||
uses: actions/deploy-pages@v4 |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,4 +27,4 @@ jobs: | |
run: pnpm install | ||
|
||
- name: Lint 🛀 | ||
run: pnpm -r run lint | ||
run: pnpm lint |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: release | ||
name: Release | ||
|
||
on: | ||
push: | ||
|
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,6 +26,7 @@ coverage | |
out/ | ||
build | ||
dist | ||
cache | ||
|
||
|
||
# Debug | ||
|
Oops, something went wrong.