Skip to content

@sylphx/bumpModern Release Automation

Conventional commits in, semantic versions out. Zero config.

bump logo

Quick Start

1. Add the workflow

Create .github/workflows/release.yml:

yaml
name: Release

on:
  push:
    branches: [main]

permissions:
  contents: write
  pull-requests: write

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: SylphxAI/bump@v1
        with:
          github-token: $\{{ secrets.GITHUB_TOKEN }}
          npm-token: $\{{ secrets.NPM_TOKEN }}

2. Add NPM_TOKEN secret

  1. Go to npmjs.com → Access Tokens → Generate New Token
  2. Go to your repo → Settings → Secrets → Actions → New repository secret
  3. Name: NPM_TOKEN, Value: your token

3. Done!

Push a commit and watch the magic happen.

Why bump?

bumpchangesets
Setup1 workflow fileMultiple config files + bot
WorkflowJust commitCreate changeset file per change
Version controlAutomatic from commitsManual per-changeset
Learning curveKnow conventional commits? DoneNew syntax + tooling
Workspace protocolAuto-resolvedManual handling required

Released under the MIT License.