Skip to content

Commit

Permalink
Add new deploy to GH pages workflow
Browse files Browse the repository at this point in the history
* Build and add EDSL API docs to GH pages
* Remove obsolete typedoc-plugin-markdown from edsl compilers
  • Loading branch information
camargo committed Feb 1, 2023
1 parent ed6e6d3 commit c15d35b
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 274 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/deploy-to-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- develop
tags:
- v*
workflow_dispatch:

permissions:
contents: read
id-token: write
pages: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: temurin
java-version: 19
- uses: gradle/gradle-build-action@v2
- name: Build EDSL API Docs
run: ./gradlew publishDocs
- name: Create Pages Build Directory
run: mkdir build
- name: Copy EDSL API Docs to Build Directory
run: |
cp -a ./merlin-server/constraints-dsl-compiler/build/docs ./build/constraints-edsl-api
cp -a ./scheduler-worker/scheduling-dsl-compiler/build/docs ./build/scheduling-edsl-api
- name: Upload Artifact
uses: actions/upload-pages-artifact@v1
with:
path: build/

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
134 changes: 1 addition & 133 deletions merlin-server/constraints-dsl-compiler/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions merlin-server/constraints-dsl-compiler/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
"build": "rm -rf build; tsc",
"test": "npm run build && node build/main.js",
"reformat": "npx prettier --config ./.prettierrc -w ./src",
"generate-doc": "rm -rf build/docs; npx typedoc --plugin typedoc-plugin-markdown src/libs/constraints-edsl-fluent-api.ts --excludePrivate --excludeInternal --out ./build/docs --name \"Constraints eDSL Documentation\" --readme none --gitRevision develop"
"generate-doc": "rm -rf build/docs; npx typedoc src/libs/constraints-edsl-fluent-api.ts --excludePrivate --excludeInternal --out ./build/docs --name \"Constraints eDSL Documentation\" --readme none --gitRevision develop"
},
"author": "",
"dependencies": {
"@nasa-jpl/aerie-ts-user-code-runner": "^0.5.0",
"@js-temporal/polyfill": "^0.4.0",
Expand All @@ -20,7 +19,6 @@
"devDependencies": {
"@tsconfig/node16-strictest-esm": "^1.0.2",
"@types/node": "^17.0.21",
"typedoc": "^0.23.10",
"typedoc-plugin-markdown": "^3.13.6"
"typedoc": "^0.23.10"
}
}
Loading

0 comments on commit c15d35b

Please sign in to comment.