f051481010
* Use reviewdog for TSC * Replace all `type Readonly<T>` with `interface T` * Use --frozen-lockfile for yarn * Give all actions a name * Fix yarn example
96 lines
2.6 KiB
YAML
96 lines
2.6 KiB
YAML
name: Build Documentation
|
|
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- '.github/workflows/build-docs.yml'
|
|
- 'src/**'
|
|
- 'docs/**'
|
|
- '*.js'
|
|
- '*.json'
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- '.github/workflows/build-docs.yml'
|
|
- 'src/**'
|
|
- 'docs/**'
|
|
- '*.js'
|
|
- '*.json'
|
|
|
|
jobs:
|
|
checks:
|
|
if: github.event_name != 'push'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- uses: actions/setup-node@v1
|
|
with:
|
|
node-version: '12.x'
|
|
|
|
- name: Get yarn cache directory path
|
|
id: yarn-cache-dir-path
|
|
run: echo "::set-output name=dir::$(yarn cache dir)"
|
|
- uses: actions/cache@v2
|
|
id: yarn-cache
|
|
with:
|
|
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
|
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-yarn-
|
|
|
|
- name: Test Docs Build
|
|
run: |
|
|
yarn install --frozen-lockfile
|
|
cd docs
|
|
yarn install --frozen-lockfile
|
|
yarn build
|
|
gh-release:
|
|
if: github.event_name != 'pull_request'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
|
|
- name: Add key to allow access to repository
|
|
env:
|
|
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
|
|
run: |
|
|
mkdir -p ~/.ssh
|
|
ssh-keyscan github.com >> ~/.ssh/known_hosts
|
|
echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
|
|
chmod 600 ~/.ssh/id_rsa
|
|
cat <<EOT >> ~/.ssh/config
|
|
Host github.com
|
|
HostName github.com
|
|
IdentityFile ~/.ssh/id_rsa
|
|
EOT
|
|
|
|
- name: Get yarn cache directory path
|
|
id: yarn-cache-dir-path
|
|
run: echo "::set-output name=dir::$(yarn cache dir)"
|
|
- name: Restore node_modules from cache
|
|
uses: actions/cache@v2
|
|
id: yarn-cache
|
|
with:
|
|
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
|
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-yarn-
|
|
|
|
- name: Release to GitHub Pages
|
|
env:
|
|
USE_SSH: true
|
|
GIT_USER: git
|
|
CURRENT_BRANCH: main
|
|
DEPLOYMENT_BRANCH: gh-pages
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
run: |
|
|
git config --global user.email "actions@github.com"
|
|
git config --global user.name "gh-actions"
|
|
yarn install --frozen-lockfile
|
|
cd docs
|
|
yarn install --frozen-lockfile
|
|
yarn deploy
|