From 90bb1da3e0eaf83c7e2e42e2d6f41adfd1ee35e6 Mon Sep 17 00:00:00 2001 From: Eonasdan Date: Thu, 22 Sep 2022 15:13:16 -0400 Subject: [PATCH] docs action (#2660) --- .github/workflows/docs.yml | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..256189dad --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,38 @@ +# This is a basic workflow to help you get started with Actions + +name: Docs + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the main branch + push: + branches: [ master ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + - name: Perform Checkout + uses: actions/checkout@v2 + - name: Setup Node + uses: actions/setup-node@v2 + with: + node-version: '16' + - name: Npm install + run: npm ci + - name: Build docs + run: npm run docs + - name: Deploy Docs + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs + keep_files: true