diff --git a/.github/workflows/gh-pages.yaml b/.github/workflows/gh-pages.yaml new file mode 100644 index 0000000..c3af784 --- /dev/null +++ b/.github/workflows/gh-pages.yaml @@ -0,0 +1,32 @@ +name: Deploy to Github Pages + +on: + push: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + + - uses: actions/setup-node@v1 + with: + node-version: '10.x' + + - name: Yarn install + run: yarn install + + - name: Build API docs + run: yarn build + + - name: Deploy to gh-pages branch + uses: peaceiris/actions-gh-pages@v2.4.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PUBLISH_BRANCH: gh-pages + PUBLISH_DIR: ./build + with: + emptyCommits: false diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..bc3ae2e --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,20 @@ +name: Lint + +on: push + +jobs: + lint: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + + - uses: actions/setup-node@v1 + with: + node-version: '10.x' + + - name: Yarn install + run: yarn install + + - name: Lint API specifications + run: yarn lint diff --git a/.gitignore b/.gitignore index 56bc926..be1a3ca 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,9 @@ npm-debug.log # IDEA .idea/ + +# Yarn +yarn-error.log + +# Build +build/ diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 414cce9..0000000 --- a/.travis.yml +++ /dev/null @@ -1,6 +0,0 @@ -language: node_js -node_js: - - "lts/*" -script: yarn lint -notifications: - email: false diff --git a/.yarnrc b/.yarnrc new file mode 100644 index 0000000..92389b3 --- /dev/null +++ b/.yarnrc @@ -0,0 +1 @@ +registry "https://maven.eveoh.nl/content/repositories/public-npm/" diff --git a/README.md b/README.md index c6c5d9b..2d05197 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ This repository contains API specifications and generated documentation for Eveo ## Publishing The OpenAPI 3.0 specifications are generated using ReDoc. -Production API documentation pages are automatically published by Github Pages when changes are pushed to the `master` branch. +Production API documentation pages are automatically built by a GitHub Workflow when changes are pushed to the `master` branch. +The resulting build is pushed to the `gh-pages` branch. +The `gh-pages` branch in turn is automatically deployed by Github Pages. ## Development diff --git a/docs/echo-webhooks.html b/docs/echo-webhooks.html index 8c674ee..8414b75 100644 --- a/docs/echo-webhooks.html +++ b/docs/echo-webhooks.html @@ -16,10 +16,10 @@
- + - \ No newline at end of file + diff --git a/docs/echo.html b/docs/echo.html index 708b210..9e6668f 100644 --- a/docs/echo.html +++ b/docs/echo.html @@ -16,10 +16,10 @@
- +