getsentry/craft repository overview

⁠Craft: Universal Release Tool (And More)

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

⁠Usage

$ docker run --rm -v $(pwd):/workspace getsentry/craft -h
craft <command>

Commands:
  craft prepare NEW-VERSION  🚢 Prepare a new release branch
                          [aliases: p, prerelease, prepublish, prepare, release]
  craft publish NEW-VERSION  🛫 Publish artifacts           [aliases: pp, publish]

Options:
  --no-input     Suppresses all user prompts          [boolean] [default: false]
  --dry-run      Dry run mode: do not perform any real actions
                                                      [boolean] [default: false]
  -v, --version  Show version number                                   [boolean]
  -h, --help     Show help                                             [boolean]

⁠Caveats

• When interacting with remote GitHub repositories, craft uses by default the "origin" remote. If you have a different setup, set the CRAFT_REMOTE environment variable.

⁠Global Configuration

Global configuration for craft can be done by using environment variables.

In either case, at least the following two values must be configured in order for craft to function properly:

• GITHUB_API_TOKEN

  Get your personal GitHub API token here: https://github.com/settings/tokens⁠

  The token only needs "repo" scope ("repo:status" and "public_repo" subscopes, to be even more precise).

• ZEUS_API_TOKEN

  You can generate your personal Zeus token here: https://zeus.ci/settings/token⁠

  Required only for craft publish.

Additional configuration may be required when publishing to specific targets (e.g. TWINE_USERNAME and TWINE_PASSWORD for PyPI target).

See our GitHub page⁠ for full documentation.