Skip to content

Commit

Permalink
[#197] Fix docs build action
Browse files Browse the repository at this point in the history
  • Loading branch information
patmagee committed Sep 14, 2023
1 parent 7ffbfed commit 3a832ab
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 37 deletions.
39 changes: 14 additions & 25 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,23 @@
name: docs-build-publish
name: Build OpenAPI docs
on:
push:
branches:
- master
- develop
- "feature/issue-*"
- "fix/issue-*"
- "support/issue-*"
pull_request_target:
branches:
- master
- develop
- "feature/issue-*"
- "fix/issue-*"
- "support/issue-*"
permissions:
contents: write
- push
# - pull_request
jobs:
docs-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Docker Pull 🐳
run: |
docker pull ga4gh/gh-openapi-docs:0.2.3-rc1
- name: Build Docs 🔧
run: |
docker run --name docs-builder --rm -v `pwd`:/docs ga4gh/gh-openapi-docs:0.2.3-rc1
- name: Setup Node.js environment
uses: actions/[email protected]
with:
node-version: 14.x
# Comes with npm 6. For newer Node, encountered: https://github.com/npm/cli/issues/3359
- run: npm install -g @redocly/openapi-cli && npm install -g redoc-cli
- run: npm install -g gh-openapi-docs
- name: Check out repository code
uses: actions/checkout@v2
- run: gh-openapi-docs
- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: publish
folder: .
14 changes: 2 additions & 12 deletions .spec-docs.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"docsRoot": "docs",
"defaultBranch": "master",
"branchPathBase": "preview",
"redocTheme": "ga4gh",
"buildPages": [
{
"apiSpecPath": "openapi/workflow_execution_service.openapi.yaml",
"htmlOutfile": "index.html",
"yamlOutfile": "openapi.yaml",
"jsonOutfile": "openapi.json"
}
]
"apiSpecPath": "openapi/workflow_execution_service.openapi.yaml",
"redocTheme": "ga4gh"
}

0 comments on commit 3a832ab

Please sign in to comment.