developer-release

Release and CLI Stability

Use this reference for release management procedures, understanding what constitutes a breaking CLI change, firewall log parsing, and Go module summaries.

Table of Contents

• Release Management
• Firewall Log Parsing
• Breaking CLI Rules
• Go Module Summaries

Release Management

The project uses a minimalistic changeset-based release system inspired by @changesets/cli.

Commands

version (Preview Only)

The version command operates in preview mode and never modifies files:

node scripts/changeset.js version
# Or
make version

This command:

• Reads all changeset files from .changeset/ directory
• Determines the appropriate version bump (major > minor > patch)
• Shows a preview of the CHANGELOG entry
• Never modifies any files

release [type] [--yes|-y]

The release command creates an actual release:

node scripts/changeset.js release
# Or (recommended - runs tests first)
make release

This command:

• Checks prerequisites (clean tree, main branch)
• Updates CHANGELOG.md with new version and changes
• Deletes processed changeset files (if any exist)
• Automatically commits the changes
• Creates and pushes a git tag for the release

Flags:

• --yes or -y: Skip confirmation prompt

Release Workflow

graph TD
    A[Add changeset files] --> B[Preview with version command]
    B --> C{Changes look good?}
    C -->|No| D[Modify changesets]
    D --> B
    C -->|Yes| E[Run release command]
    E --> F[Update CHANGELOG.md]
    F --> G[Delete changeset files]
    G --> H[Commit changes]
    H --> I[Create git tag]
    I --> J[Push tag to remote]

Changeset File Format

Changeset files are markdown files in .changeset/ directory with YAML frontmatter:

"gh-aw": patch

Brief description of the change

Bump types:

• patch - Bug fixes and minor changes (0.0.x)
• minor - New features, backward compatible (0.x.0)
• major - Breaking changes (x.0.0)