forked from jspecify/jspecify
-
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
Showing
74 changed files
with
69 additions
and
5,061 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
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 |
---|---|---|
|
@@ -4,32 +4,32 @@ on: | |
push: | ||
branches: [ main ] | ||
pull_request: | ||
branches: | ||
- main | ||
branches: [ main ] | ||
|
||
jobs: | ||
# Runs on PRs and push to ensure the documentation successfully builds. | ||
build: | ||
name: Build Documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Check out project | ||
uses: actions/checkout@v4 | ||
|
||
- uses: actions/setup-node@v4 | ||
- name: Set up Java | ||
uses: actions/setup-java@v4 | ||
with: | ||
node-version: 18 | ||
distribution: temurin | ||
java-version: 22 | ||
|
||
- name: Install Dependencies | ||
run: npm install | ||
working-directory: docs | ||
- name: Set up Gradle | ||
uses: gradle/actions/setup-gradle@v3 | ||
|
||
- name: Build Documentation | ||
run: npm run build | ||
working-directory: docs | ||
- name: Build docs | ||
run: ./gradlew buildDocs | ||
|
||
- uses: actions/upload-artifact@v4 | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
name: document | ||
path: docs/build | ||
|
||
# Deploys the documentation if this is a push to the main branch. | ||
|
@@ -38,15 +38,18 @@ jobs: | |
if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
needs: build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: actions/download-artifact@v4 | ||
with: | ||
name: document | ||
path: docs/build | ||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
permissions: | ||
pages: write # to deploy to Pages | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
|
||
- uses: JamesIves/[email protected] | ||
with: | ||
branch: gh-pages | ||
folder: docs/build | ||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.