-
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.
- Loading branch information
1 parent
50c1b1f
commit c18bd4f
Showing
6 changed files
with
266 additions
and
1 deletion.
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,93 @@ | ||
| name: Documentation | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| tags: | ||
| - 'v*' | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build Documentation | ||
| runs-on: ubuntu-latest | ||
|
|
||
| if: github.repository_owner == 'RealShadowNova' | ||
| steps: | ||
| - name: Checkout Project | ||
| uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 | ||
| - name: Use Node.js v16 | ||
| uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # tag=v3 | ||
| with: | ||
| node-version: 16 | ||
| cache: yarn | ||
| registry-url: https://registry.npmjs.org/ | ||
| - name: Install Dependencies | ||
| run: yarn --immutable | ||
| - name: Build Documentation | ||
| run: yarn docs | ||
| - name: Upload Documentation Artifacts | ||
| uses: actions/cache@v2 | ||
| with: | ||
| name: docs | ||
| path: docs/api.json | ||
| - name: Set Output | ||
| id: env | ||
| run: | | ||
| echo "::set-output name=NAME::${GITHUB_REF_NAME}" | ||
| echo "::set-output name=TYPE::${GITHUB_REF_TYPE}" | ||
| echo "::set-output name=SHA::${GITHUB_SHA}" | ||
| upload: | ||
| name: Upload Documentation | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| NAME: ${{ needs.build.outputs.REF }} | ||
| TYPE: ${{ needs.build.outputs.TYPE }} | ||
| SHA: ${{ needs.build.outputs.SHA }} | ||
| steps: | ||
| - name: Checkout Project | ||
| uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 | ||
| - name: Use Node.js v16 | ||
| uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048 # tag=v3 | ||
| with: | ||
| node-version: 16 | ||
| cache: yarn | ||
| registry-url: https://registry.npmjs.org/ | ||
| - name: Install Dependencies | ||
| run: yarn --immutable | ||
| - name: Download Documentation Artifacts | ||
| uses: actions/download-artifact@v2 | ||
| with: | ||
| name: docs | ||
| path: docs | ||
| - name: Checkout Documentation Project | ||
| uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3 | ||
| with: | ||
| repository: 'RealShadowNova/docs' | ||
| path: 'out' | ||
|
|
||
| - name: Move Documentation | ||
| if: ${{ env.TYPE == 'tag' }} | ||
| env: | ||
| SEMVER: ${{ env.NAME }} | ||
| run: | | ||
| mkdir -p out/property-helpers | ||
| mv docs/api.json out/property-helpers/${SEMVER}.json | ||
| - name: Move Documentation | ||
| if: ${{ env.TYPE == 'branch' }} | ||
| run: | | ||
| mkdir -p out/property-helpers | ||
| mv docs/api.json out/property-helpers/${NAME}.json | ||
| - name: Commit & Push | ||
| run: | | ||
| cd out | ||
| git config user.name github-actions[bot] | ||
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | ||
| git add . | ||
| git commit -m "docs(property-helpers): build for ${TYPE} ${NAME}: ${SHA}" | ||
| git 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ node_modules/ | |
| # Build Artifacts | ||
| dist/ | ||
| build/ | ||
| docs/ | ||
|
|
||
| # Ignore heapsnapshot and log files | ||
| *.heapsnapshot | ||
|
|
||
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 @@ | ||
| json: 'docs/api.json' |
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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "$schema": "https://typedoc.org/schema.json", | ||
| "entryPoints": ["src/index.ts"], | ||
| "json": "docs/api.json", | ||
| "treatWarningsAsErrors": true, | ||
| "tsconfig": "src/tsconfig.json" | ||
| } |
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