Skip to content

Commit

Permalink
README and dev doc updates
Browse files Browse the repository at this point in the history
- Consolidate all dev docs into CONTRIBUTING.md
- Document the release process (such as I understand it)
  • Loading branch information
josh-berry committed Sep 20, 2023
1 parent 0e945d6 commit 582bbee
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 22 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ Build the `temporal` binary:
go build ./cmd/temporal
```

## Generate docs

```bash
go build -o temporal-doc-gen ./cmd/docgen
./temporal-doc-gen
```

Docs are generated as Markdown files in `./docs`.

## Run tests

Run all tests:
Expand Down Expand Up @@ -73,3 +82,22 @@ To verify that this file is up to date execute:
```bash
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 pick up the tag and build the release artifacts.
5. Open a PR against Homebrew to modify [the temporal formula] to fetch the
source tarball using the latest release from GitHub. Don't forget to update
the checksum of the source tarball. ([Example PR])
- Homebrew should take care of rebottling the formula and updating the bottle
checksums; you don't need to do this yourself.
6. TODO: Describe how to update `temporal.download` links

[the temporal formula]: https://github.com/Homebrew/homebrew-core/blob/master/Formula/t/temporal.rb
[Example PR]: https://github.com/Homebrew/homebrew-core/commit/23f09be7fe7e2b00eee53a12db9a5a15c1c206ff
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ Use the CLI to run a Temporal Server and interact with it.
- [macOS installation](#macos-installation)
- [Linux installation](#linux-installation)
- [🔧 Development](#-development)
- [Compile and run CLI](#compile-and-run-cli)
- [Compile docs](#compile-docs)
- [Run tests](#run-tests)
- [⚠️ Known Issues](#-known-issues)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -212,7 +209,7 @@ or:
[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"
```

Verify that `bash-completion` is installed by running `type _init_completion`.
Verify that `bash-completion` is installed by running `type _init_completion`.
It should say `_init_completion is a function` and print the function.

Enable completion for Temporal by adding the following code to your bash file:
Expand Down Expand Up @@ -262,24 +259,7 @@ source ~/.bashrc

## 🔧 Development

### Compile and run CLI

```bash
go build -o dist/temporal ./cmd/temporal
dist/temporal
```

### Compile docs

```bash
go build -o dist/temporal-docgen ./cmd/temporal-docgen
```

### Run tests

```bash
go test ./...
```
See [CONTRIBUTING.md](CONTRIBUTING.md)

## ⚠️ Known Issues

Expand Down

0 comments on commit 582bbee

Please sign in to comment.