Skip to content

feat: add type docs

feat: add type docs #8

Workflow file for this run

name: 🧪 Test & 🗂️ Build & 🚀 Release
on:
push:
branches:
- master
- beta
jobs:
test:
name: Run Tests 🧪
runs-on: ubuntu-latest
strategy:
matrix:
node: [16, 18, 20]
steps:
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: ${{matrix.node}}
- name: Checkout
uses: actions/checkout@v3
- name: Cache Node Modules
uses: actions/cache@v3
with:
path: node_modules
key: ${{ hashFiles('**/package-lock.json') }}
- name: Install node_modules
run: npm ci
- name: Run tests
run: npm run test
build:
name: 🗂️ Build files
runs-on: ubuntu-latest
needs:
- test
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ secrets.NODE_VERSION }}
- name: Cache Node Modules
uses: actions/cache@v3
with:
path: node_modules
key: ${{ hashFiles('**/package-lock.json') }}
- name: Install node_modules
run: npm i
- name: Build Files
run: npm run build
- uses: actions/upload-artifact@v3
if: success()
with:
name: dist
path: dist
release:
name: 🚀 Release Next Version
runs-on: ubuntu-latest
needs:
- test
- build
permissions:
contents: write # to be able to publish a GitHub release
issues: write # to be able to comment on released issues
pull-requests: write # to be able to comment on released pull requests
steps:
- name: Checkout
uses: actions/checkout@v3
with:
persist-credentials: false
- uses: actions/download-artifact@v3
with:
name: dist
path: dist
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
npx semantic-release