Add docs #38
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# workflow to publish on npm | |
name: publish | |
on: | |
# trigger on main branch | |
push: | |
branches: [main] | |
# allow manual dispatch | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
node-version: [18.x] | |
steps: | |
# checkout repo | |
- name: Git checkout | |
uses: actions/checkout@v2 | |
# setup Node.js | |
- name: Set Node.js - v${{ matrix.node-version }} | |
uses: actions/setup-node@v2 | |
with: | |
node-version: ${{ matrix.node-version }} | |
# install dependencies | |
- name: Install dependencies | |
run: yarn | |
# run tests | |
- name: Run tests | |
run: yarn test | |
# coverage | |
- name: Publish code coverage | |
uses: paambaati/[email protected] | |
env: | |
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }} | |
with: | |
coverageCommand: yarn coverage | |
debug: true | |
# build dist | |
- name: Build package | |
run: yarn build | |
# publish on npm | |
- uses: JS-DevTools/npm-publish@v1 | |
with: | |
token: ${{ secrets.NPM_TOKEN }} | |
access: "public" |