craft - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #llm #go #machine-learning #linux #docker #java #windows #cli #awesome-list #open-source

craft

(★ 193)

The universal Sentry release CLI 🚀

File Explorer

Download Latest Version (.zip)

- - build.yml
  - changelog-preview.yml
  - docs-preview.yml
  - enforce-license-compliance.yml
  - image.yml
  - lint.yml
  - release.yml
- extensions.json
- settings.json
- - CNAME
  - favicon.svg
- - content.config.ts
- astro.config.mjs
- package.json
- pnpm-lock.yaml
- tsconfig.json
- icon.svg
- logo.svg
- - fs.ts
  - logger.ts
- - config.test.ts
  - index.test.ts
  - prepare-dry-run.e2e.test.ts
  - versionBump.test.ts
- - base.ts
  - gcs.ts
  - github.ts
  - none.ts
- - artifacts.ts
  - changelog.ts
  - config.ts
  - prepare.ts
  - publish.ts
  - targets.ts
- - project_config.ts
- - base.ts
  - github.ts
- - awsLambdaLayer.ts
  - base.ts
  - brew.ts
  - cloudflare.ts
  - cocoapods.ts
  - commitOnGitRepository.ts
  - crates.ts
  - docker.ts
  - gcs.ts
  - gem.ts
  - ghPages.ts
  - github.ts
  - hex.ts
  - index.ts
  - maven.ts
  - npm.ts
  - nuget.ts
  - powershell.ts
  - pubDev.ts
  - pypi.ts
  - registry.ts
  - sentryPypi.ts
  - symbolCollector.ts
  - upm.ts
  - vercel.ts
- - mustache.d.ts
  - split.d.ts
- - async.ts
  - autoVersion.ts
  - awsLambdaLayerManager.ts
  - calver.ts
  - changelog.ts
  - checksum.ts
  - detection.ts
  - dryRun.ts
  - dynamicLinkerEnv.ts
  - env.ts
  - errors.ts
  - files.ts
  - filters.ts
  - gcsApi.ts
  - git.ts
  - githubApi.ts
  - gpg.ts
  - helpers.ts
  - import-meta-url.js
  - objects.ts
  - packagePath.ts
  - publishState.ts
  - registry.ts
  - releaseCommandEnv.ts
  - strings.ts
  - symlink.ts
  - system.ts
  - tracing.ts
  - version.ts
  - versionBump.ts
  - workspaces.ts
- config.ts
- index.ts
- instrument.ts
- logger.ts
.craft.yml
.dockerignore
.gitignore
.lore.md
.nojekyll
.npmignore
.prettierignore
.prettierrc.yml
action.yml
AGENTS.md
blog-post-draft.md
build.mjs
CHANGELOG.md
CONTRIBUTING.md
Dockerfile
eslint.config.mjs
LICENSE
package.json
pnpm-lock.yaml
README.md
tsconfig.build.json
tsconfig.json
vitest.config.mts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
    <img src="img/logo.svg" width="280">
    <br />
</p>

# Craft: Universal Release Tool

[![GitHub release](https://img.shields.io/github/release/getsentry/craft.svg)](https://github.com/getsentry/craft/releases/latest)
[![npm version](https://img.shields.io/npm/v/@sentry/craft.svg)](https://www.npmjs.com/package/@sentry/craft)
[![license](https://img.shields.io/github/license/getsentry/craft.svg)](https://github.com/getsentry/craft/blob/master/LICENSE)

Craft is a command line tool that helps automate and pipeline package releases. It enforces a specific workflow for managing release branches, changelogs, and artifact publishing.

📚 **[Full Documentation](https://getsentry.github.io/craft/)**

## Quick Start

### Installation

Download the [latest binary release](https://github.com/getsentry/craft/releases/latest), or install via npm:

```shell
npm install -g @sentry/craft
```

### Usage

```shell
# Auto-determine version from conventional commits
craft prepare auto

# Or specify a version explicitly
craft prepare 1.2.3

# Publish to all configured targets
craft publish 1.2.3
```

## Features

- **Auto Versioning** - Automatically determine version bumps from conventional commits
- **Multiple Targets** - Publish to GitHub, NPM, PyPI, Docker, Crates.io, NuGet, and more
- **Changelog Management** - Auto-generate changelogs from commits or validate manual entries
- **Workspace Support** - Handle monorepos with NPM/Yarn workspaces
- **CI Integration** - Wait for CI to pass, download artifacts, and publish
- **GitHub Actions** - Built-in actions for release preparation and changelog previews

## Configuration

Create a `.craft.yml` in your project root:

```yaml
minVersion: '2.0.0'
changelog:
  policy: auto
targets:
  - name: github
  - name: npm
    access: public
```

See the [configuration reference](https://getsentry.github.io/craft/configuration/) for all options.

## Supported Targets

| Target             | Description                           |
| ------------------ | ------------------------------------- |
| `github`           | GitHub releases and tags              |
| `npm`              | NPM registry (with workspace support) |
| `pypi`             | Python Package Index                  |
| `crates`           | Rust crates.io                        |
| `nuget`            | .NET NuGet                            |
| `docker`           | Docker registries                     |
| `brew`             | Homebrew formulas                     |
| `gcs`              | Google Cloud Storage                  |
| `gh-pages`         | GitHub Pages                          |
| `cocoapods`        | CocoaPods                             |
| `gem`              | RubyGems                              |
| `maven`            | Maven Central                         |
| `hex`              | Elixir Hex                            |
| `pub-dev`          | Dart/Flutter pub.dev                  |
| `aws-lambda-layer` | AWS Lambda layers                     |
| `powershell`       | PowerShell Gallery                    |

See the [targets documentation](https://getsentry.github.io/craft/targets/) for configuration details.

## GitHub Actions

Craft provides GitHub Actions for automating releases and previewing changelog entries.

### Prepare Release Action

Automates the `craft prepare` workflow in GitHub Actions:

```yaml
name: Release
on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Version to release (or "auto")'
        required: false

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: getsentry/craft@v2
        with:
          version: ${{ github.event.inputs.version }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

**Inputs:**

| Input           | Description                                                                                   | Default                              |
| --------------- | --------------------------------------------------------------------------------------------- | ------------------------------------ |
| `version`       | Version to release (semver, "auto", "major", "minor", "patch")                                | Uses `versioning.policy` from config |
| `merge_target`  | Target branch to merge into                                                                   | Default branch                       |
| `force`         | Force release even with blockers                                                              | `false`                              |
| `blocker_label` | Label that blocks releases                                                                    | `release-blocker`                    |
| `publish_repo`  | Repository for publish issues. Use `"self"` to create issues in the source repository itself. | `{owner}/publish`                    |

**Outputs:**

| Output      | Description                          |
| ----------- | ------------------------------------ |
| `version`   | The resolved version being released  |
| `branch`    | The release branch name              |
| `sha`       | The commit SHA on the release branch |
| `changelog` | The changelog for this release       |

### Changelog Preview (Reusable Workflow)

Posts a preview comment on PRs showing how they'll appear in the changelog:

```yaml
name: Changelog Preview
on:
  pull_request:
    types: [opened, synchronize, reopened, edited, labeled]

jobs:
  changelog-preview:
    uses: getsentry/craft/.github/workflows/changelog-preview.yml@v2
    secrets: inherit
```

The workflow will:

- Generate the upcoming changelog including the PR's changes
- Highlight entries from the PR using blockquote style (left border)
- Post a comment on the PR with the preview
- Automatically update when you update the PR (push, edit title/description, or change labels)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.

## License

MIT