Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

117 lines (79 loc) · 3.69 KB
Raw

Develop

This doc is for contributors to Temporal CLI (hopefully that's you!)

Prerequisites

Build prerequisites

  • Go Lang (minimum version required is 1.19):
    • Install on macOS with brew install go.
    • Install on Ubuntu with sudo apt install golang.

Check out the code

Temporal CLI uses go modules, there is no dependency on $GOPATH variable. Clone the repo into the preferred location:

git clone https://github.com/temporalio/cli.git

Makefile

There is a very simple Makefile available for the convenience of UNIXy developers which covers most of the points below. The default target will do a clean build (make clean && make build), and make test will run tests.

Build

Build the temporal binary:

go build ./cmd/temporal

Generate docs

go run ./cmd/docgen

Docs are generated as Markdown files in ./docs.

Run tests

Run all tests:

go test ./...

Run Temporal CLI locally

By default the server runs in in-memory mode:

go run ./cmd/temporal server start-dev

Pass --db-filename to persist the state in an SQLite DB

Now you can create default namespace:

temporal namespace register default

and run samples from Go and Java samples repos.

When you are done, press Ctrl+C to stop the server.

License headers

This project is Open Source Software, and requires a header at the beginning of all source files. To verify that all files contain the header execute:

go run ./cmd/copyright

Third party code

The license, origin, and copyright of all third party code is tracked in LICENSE-3rdparty.csv. To verify that this file is up to date execute:

go run ./cmd/licensecheck

Release process

If you're a Temporal engineer / code owner, here's how to do a release:

  1. Do some manual testing to make sure things look good--start a dev-server, run some workflows, etc.
  2. Make sure CI is passing on main.
  3. Create a tag of the form vX.Y.Z off of main and push it to GitHub.
  4. GoReleaser will automatically create a GitHub release from the tag, and will build and publish the release artifacts.
  5. Update the release notes on GitHub to summarize what's changed.
  6. The temporal.download links will automatically update once the artifacts are available.
  7. Follow Homebrew's instructions to bump the CLI version in Homebrew. tl;dr:
    1. [first time only] brew tap homebrew/core [email protected]:Homebrew/homebrew-core.git
    2. [first time only] Fixup homebrew/core to use SSH, or it won't be able to push to your fork: git -C /opt/homebrew/Library/Taps/homebrew/homebrew-core remote set-url origin [email protected]:Homebrew/homebrew-core
    3. brew bump-formula-pr --strict temporal --url=https://github.com/temporalio/cli/archive/refs/tags/vXXX.tar.gz (replace vXXX with the tag name)
  8. Re-generate the docs, and follow the docs team's process to update the CLI documentation.

For reference, here are all of the places where releases get published: https://docs.temporal.io/cli/#installation