Skip to content

chore: fix readme

chore: fix readme #25

Workflow file for this run

name: release to package managers
concurrency: ${{ github.workflow }}-${{ github.ref }}
on:
push:
branches:
- main
# workflow_dispatch:
# inputs:
# forceGPR:
# description: Force GPR release
# type: boolean
# required: false
# default: false
jobs:
install-deps:
name: πŸ“¦ Install dependencies
if: github.repository == 'lukemorales/exhaustive' && github.event_name != 'pull_request'
runs-on: ubuntu-latest
steps:
- name: πŸ”‘ Checkout Repository
uses: actions/checkout@v4
- name: πŸ”§ Install PNPM
uses: pnpm/action-setup@v3
with:
version: 9
- name: ♻️ Cache node_modules
uses: actions/cache@v3
id: pnpm-cache
with:
path: "**/node_modules"
key: ${{ runner.os }}-node-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-node-
- name: πŸ› οΈ Setup Node and install project dependencies
uses: actions/setup-node@v4
with:
node-version: 18
check-latest: true
cache: 'pnpm'
if: steps.pnpm-cache.outputs.cache-hit != 'true'
- run: pnpm install --prefer-offline
build:
name: πŸ—οΈ Build package
runs-on: ubuntu-latest
needs: install-deps
steps:
- name: πŸ”‘ Checkout Repository
uses: actions/checkout@v4
- name: πŸ”§ Install PNPM
uses: pnpm/action-setup@v3
with:
version: 9
- name: πŸ› οΈ Setup Node
uses: actions/setup-node@v4
with:
node-version: 18
check-latest: true
cache: 'pnpm'
- name: πŸ“¦ Install dependencies
if: steps.pnpm-cache.outputs.cache-hit != 'true'
run: pnpm install --prefer-offline
- name: 🚨 Check for errors
run: pnpm run lint
- name: πŸ§ͺ Run tests
run: pnpm run test:ci
- name: βš’οΈ Build package
run: pnpm run build
release:
name: πŸš€ Release to NPM
if: github.event.inputs.forceGPR != 'true'
runs-on: ubuntu-latest
needs: build
outputs:
published: ${{ steps.changesets.outputs.published }}
steps:
- name: πŸ”‘ Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: πŸ”§ Install PNPM
uses: pnpm/action-setup@v3
with:
version: 9
- name: ♻️ Load node_modules
uses: actions/cache@v3
with:
path: "**/node_modules"
key: ${{ runner.os }}-node-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: ♻️ Load build files
uses: actions/cache@v3
with:
path: "**/dist"
key: ${{ runner.os }}-build-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: πŸ› οΈ Setup Node for NPM
uses: actions/setup-node@v4
with:
node-version: 18
check-latest: true
cache: 'pnpm'
registry-url: 'https://registry.npmjs.org'
- name: πŸ‘€ Set git user
run: |
git config --global user.email "lukemorales@live.com"
git config --global user.name "Luke Morales"
- name: πŸš€ Create Changesets Pull Request or Publish to NPM
id: changesets
uses: changesets/action@v1
with:
setupGitUser: false
title: "chore(changesets): bump package version"
commit: "chore: bump package version"
version: node .github/changeset-version.js
publish: pnpm run release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
# gpr-release:
# name: πŸš€ Release to GitHub Package Manager
# if: github.event.inputs.forceGPR == 'true' || needs.release.outputs.published == 'true'
# runs-on: ubuntu-latest
# needs: [build, release]
# permissions:
# contents: read
# packages: write
# steps:
# - name: πŸ”‘ Checkout Repository
# uses: actions/checkout@v4
# - name: πŸ”§ Install PNPM
# uses: pnpm/action-setup@v3
# with:
# version: 9
# - name: ♻️ Load node_modules
# uses: actions/cache@v3
# with:
# path: "**/node_modules"
# key: ${{ runner.os }}-node-${{ hashFiles('**/pnpm-lock.yaml') }}
# - name: πŸ› οΈ Setup Node for GPR
# uses: actions/setup-node@v4
# with:
# node-version: '16.14.2'
# check-latest: true
# cache: 'pnpm'
# registry-url: 'https://npm.pkg.github.com'
# - name: πŸ“¦ Install dependencies
# if: steps.pnpm-cache.outputs.cache-hit != 'true'
# run: pnpm install --prefer-offline
# - name: βš’οΈ Build package
# run: pnpm run build
# - name: πŸš€ Publish to GPR
# run: pnpm publish
# env:
# NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}