Workflow

Here's a typical end-to-end versioning workflow using Nyron, from checking changes to creating a release.

Complete Release Workflow

Basic Workflow (Simplest)

The simplest workflow without manual tag pushing:

# 1. Bump version and generate changelog
npx @nyron/cli bump --type minor --prefix v

# 2. Commit changes
git add .
git commit -m "chore: bump version to 1.2.0"

# 3. Create GitHub release (this also creates the tag)
npx @nyron/cli release

# 4. Push commits
git push

The release command automatically:

Generates a nyron-release tag with timestamp
Creates and pushes the tag to GitHub
Creates the GitHub release with auto-generated changelog

Workflow with GPG-Signed Tags (Advanced)

If you want to GPG-sign your release tags locally before pushing:

# 1. Bump version and generate changelog
npx @nyron/cli bump --type minor --prefix v

# 2. Commit changes
git add .
git commit -m "chore: bump version to 1.2.0"

# 3. Create and push GPG-signed tag
npx @nyron/cli push-tag

# 4. Create GitHub release (skip tag creation with -n)
npx @nyron/cli release -n

# 5. Push commits
git push

Why use this workflow?

GPG signs the tag locally before pushing
Provides cryptographic verification
Shows "Verified" badge on GitHub
Proves authenticity of the release

Monorepo Workflow

For monorepos with multiple packages, the workflow is the same but you specify which package to release:

Basic Monorepo Workflow

# Bump specific package
npx @nyron/cli bump --type patch --prefix @myapp/api@

# Commit changes
git add .
git commit -m "chore(api): bump version to 1.0.1"

# Create release (creates tag automatically)
npx @nyron/cli release

# Push commits
git push

With GPG-Signed Tags

# Bump specific package
npx @nyron/cli bump --type patch --prefix @myapp/api@

# Commit changes
git add .
git commit -m "chore(api): bump version to 1.0.1"

# Create GPG-signed tag
npx @nyron/cli push-tag

# Create release (skip tag creation)
npx @nyron/cli release -n

# Push commits
git push

Version Bump Decision Guide

Choose the appropriate bump type based on your changes:

Major (`--type major`)

Use for breaking changes that require users to update their code:

API changes that break compatibility
Removal of deprecated features
Major architectural changes

Example: 1.5.2 → 2.0.0

Minor (`--type minor`)

Use for new features that are backward compatible:

New functionality
New API endpoints
Feature enhancements

Example: 1.5.2 → 1.6.0

Patch (`--type patch`)

Use for bug fixes and minor updates:

Bug fixes
Documentation updates
Performance improvements (non-breaking)

Example: 1.5.2 → 1.5.3

Automated Release Workflow

You can set up a GitHub Actions workflow that automatically creates releases when you push nyron-release tags locally. This is useful for:

GPG-signing tags locally before pushing
Triggering automated release creation
Separating local development from release publishing

Setup CI/CD Workflow

Create .github/workflows/release.yml in your repository:

name: Publish Github Release Using Nyron

on:
  push:
    tags:
      - 'nyron-release@*'

permissions:
  contents: write

jobs:
  publish-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # Fetch all history to ensure latest tag is available
      
      - uses: oven-sh/setup-bun@v2
        with:
          bun-version: latest

      - run: bun install
      - run: bun x @nyron/cli release -n
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

Note: The -n flag tells the release command to skip creating a new tag, since you already created it locally with push-tag.

Usage

When ready to release:

# 1. Bump and commit
npx @nyron/cli bump --type minor --prefix v
git add . && git commit -m "chore: bump version to 1.2.0"

# 2. Push tag (creates GPG-signed tag and triggers the workflow)
npx @nyron/cli push-tag

# 3. Push your commits
git push

# The GitHub Actions workflow automatically creates the release! 🎉

Comparison: Local vs Automated

Local Release (No CI/CD):

npx @nyron/cli bump --type minor --prefix v
git add . && git commit -m "chore: bump version to 1.2.0"
npx @nyron/cli release  # Creates tag & release locally
git push

Automated Release (With CI/CD):

npx @nyron/cli bump --type minor --prefix v
git add . && git commit -m "chore: bump version to 1.2.0"
npx @nyron/cli push-tag  # Creates GPG-signed tag, triggers CI/CD
git push  # CI/CD creates the release for you

Benefits of Automated Workflow:

✅ GPG-sign tags locally for verified releases
✅ Separate concerns (local dev vs release publishing)
✅ Consistent release environment
✅ No need to have GITHUB_TOKEN locally

Customizing the Workflow

You can modify the workflow to use npm, pnpm, or Node.js instead of Bun:

# For npm
- uses: actions/setup-node@v4
  with:
    node-version: '20'
- run: npm install
- run: npx @nyron/cli release

# For pnpm
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v4
  with:
    node-version: '20'
    cache: 'pnpm'
- run: pnpm install
- run: pnpm exec @nyron/cli release

Pro Tips

Use the reminder feature

If you have onPushReminder: true in your config, Nyron will remind you to push your tags after creating them.

Preview releases

You can preview what will be included in a release using the dry-run flag:

npx @nyron/cli release --dry-run

Learn about all available commands
Understand how Nyron works under the hood
Review configuration options
Set up GitHub repository settings

Workflow

Workflow

Complete Release Workflow

Basic Workflow (Simplest)

Workflow with GPG-Signed Tags (Advanced)

Monorepo Workflow

Basic Monorepo Workflow

With GPG-Signed Tags

Version Bump Decision Guide

Major (`--type major`)

Minor (`--type minor`)

Patch (`--type patch`)

Automated Release Workflow

Setup CI/CD Workflow

Usage

Comparison: Local vs Automated

Customizing the Workflow

Pro Tips

Use the reminder feature

Preview releases

Consistent commit messages

Configure GitHub repository settings

Next Steps

On this page