Updated readme #48
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
name: Continuous Integration | |
on: | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
workflow_call: | |
pull_request: | |
jobs: | |
ci: | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ubuntu-latest, macos-latest, windows-latest] | |
name: ${{ matrix.os }} | |
permissions: | |
contents: read | |
id-token: write | |
defaults: | |
run: | |
shell: bash | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Set up Node.js | |
uses: actions/setup-node@v3 | |
with: | |
node-version: 18 | |
- name: Install dependencies | |
run: npm install | |
- name: Formatting | |
run: npm run format:check | |
- name: Linting | |
run: npm run lint | |
#- name: Unit tests | |
# run: npm run test | |
- name: Build | |
run: npm run build | |
docs: | |
needs: ci | |
runs-on: ubuntu-latest | |
name: Docs build and deploy | |
permissions: | |
contents: write | |
id-token: write | |
pages: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deploy.outputs.page_url }} | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Set up Node.js | |
uses: actions/setup-node@v3 | |
with: | |
node-version: 18 | |
- name: Install dependencies | |
run: npm install | |
- name: Build docs | |
run: npm run build:docs | |
- name: Upload docs artifact | |
uses: actions/upload-pages-artifact@v3 | |
if: github.event_name != 'pull_request' | |
with: | |
path: ./docs | |
- name: 'Deploy docs' | |
id: deploy | |
if: github.event_name != 'pull_request' | |
uses: actions/deploy-pages@v4 |