Skip to content

Add: help to readme

Add: help to readme #5

Workflow file for this run

name: NPM Publish
on:
push:
branches: [ "main" ]
paths:
- 'package.json'
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [20.x]
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- run: npm ci
- run: npm run build --if-present
- run: npm run test --if-present
- uses: actions/upload-artifact@v4
with:
name: build-artifacts
path: dist
# publish-gpr:
# needs: build
# runs-on: ubuntu-latest
# permissions:
# contents: read
# packages: write
# steps:
# - uses: actions/checkout@v4
# - uses: actions/setup-node@v3
# with:
# node-version: 20
# - uses: actions/download-artifact@v4
# with:
# name: build-artifacts
# path: dist
# - run: |
# npm config set registry "https://npm.pkg.github.com/"
# npm config set scope "@${{ github.repository_owner }}"
# npm publish
# env:
# NODE_AUTH_TOKEN: ${{ github.token }}
publish-npm:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: 20
registry-url: https://registry.npmjs.org/
- uses: actions/download-artifact@v4
with:
name: build-artifacts
path: dist
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}