7b50331b98
* docs: more updates * minor changes * workflow * yarn * structure * more updates * cleanup * additional cleanup * docs * interact with node * additional guides and testnet docs * update swagger * update docs * action
58 lines
1.6 KiB
YAML
58 lines
1.6 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
# trigger deployment on every push to main branch
|
|
push:
|
|
branches:
|
|
- main
|
|
# trigger deployment manually
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2.3.4
|
|
with:
|
|
# fetch all commits to get last updated time or other git log info
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v1
|
|
with:
|
|
# choose node.js version to use
|
|
node-version: '14'
|
|
|
|
# cache node_modules
|
|
- name: Cache dependencies
|
|
uses: actions/cache@v2
|
|
id: yarn-cache
|
|
with:
|
|
path: |
|
|
**/node_modules
|
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-yarn-
|
|
|
|
# install dependencies if the cache did not hit
|
|
- name: Install dependencies
|
|
if: steps.yarn-cache.outputs.cache-hit != 'true'
|
|
run: yarn --frozen-lockfile
|
|
|
|
# run build script
|
|
- name: Build VuePress site
|
|
run: yarn docs:build
|
|
|
|
# please check out the docs of the workflow for more details
|
|
# @see https://github.com/crazy-max/ghaction-github-pages
|
|
- name: Deploy to GitHub Pages
|
|
uses: crazy-max/ghaction-github-pages@v2
|
|
with:
|
|
# deploy to gh-pages branch
|
|
target_branch: gh-pages
|
|
# deploy the default output dir of VuePress
|
|
build_dir: docs/.vuepress/dist
|
|
env:
|
|
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |