This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

Release v3.3.0 (#320) #7

	name: Generate Reference and Deploy Github Pages

	on:
	push:
	branches:
	- master
	workflow_dispatch:

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	# Allow one concurrent deployment
	concurrency:
	group: "pages"
	cancel-in-progress: true

	jobs:
	generate-reference:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- name: Cache node modules
	id: cache-npm
	uses: actions/cache@v3
	env:
	cache-name: cache-node-modules
	with:
	# npm cache files are stored in `~/.npm` on Linux/macOS
	path: ~/.npm
	key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
	restore-keys: \|
	${{ runner.os }}-build-${{ env.cache-name }}-
	${{ runner.os }}-build-
	${{ runner.os }}-
	- if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
	name: List the state of node modules
	continue-on-error: true
	run: npm list

	- name: Install dependencies
	run: npm install

	- name: generate reference
	run: npm run document:generate

	- name: zip docs
	run: zip -r docs.zip docs/

	- name: Archive artifacts
	uses: actions/upload-artifact@v3
	with:
	name: docs
	path: docs.zip

	- name: Setup Pages
	uses: actions/configure-pages@v2

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v1
	with:
	path: './docs'

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: generate-reference
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v1

Provide feedback