Skip to content

update npm package readme #40

update npm package readme

update npm package readme #40

Workflow file for this run

name: Release
on:
push:
tags:
- 'v*.*.*'
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
cancel-in-progress: true
jobs:
artifacts:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: 'recursive'
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
- name: Tests
run: forge test --no-match-contract DispatcherDeployTest
- name: Check contract sizes
run: rm -rf out && forge build contracts/ --sizes --deny-warnings
- name: Save compiled contracts and ABIs
if: success()
run: |
mkdir -p release-artifacts
cp -r out release-artifacts
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: compiled-contracts
path: release-artifacts
release:
runs-on: ubuntu-latest
needs: artifacts
environment: release
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: "recursive"
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: compiled-contracts
path: ./release-artifacts
- name: Create Release
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/')
with:
files: release-artifacts/**
generate_release_notes: true
draft: false
prerelease: false
token: ${{ secrets.RELEASE_TOKEN }}
registries:
runs-on: ubuntu-latest
needs: release
environment: release
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: "recursive"
- name: Get Latest Version
id: version
uses: pozetroninc/github-action-get-latest-release@master
with:
repository: ${{ github.repository }}
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.21.3'
- name: Setup Foundry
uses: foundry-rs/foundry-toolchain@v1
- name: Install ABIGen
run: |
go install github.com/ethereum/go-ethereum/cmd/abigen@v1.13.5
- uses: actions/setup-node@v4
with:
node-version: '22.3.0'
registry-url: 'https://registry.npmjs.org'
- name: Install Bun
uses: oven-sh/setup-bun@v2
# Ensure /v2 is updated as the major version changes
- name: Update Go Registry
run: |
GOPROXY=proxy.golang.org go list \
-m github.com/open-ibc/vibc-core-smart-contracts/v2@${{ steps.version.outputs.release }}
- name: Update NPM Registry
run: |
bun install --frozen-lockfile
bun run build
npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}