Skip to content

Commit

Permalink
Update docs for release to clarify questions. (#1766)
Browse files Browse the repository at this point in the history
Pass at clarifying documentation based upon questions in #1562.
  • Loading branch information
nathanhammond authored Aug 25, 2022
1 parent 06ce4b1 commit e80d380
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ jobs:
# Optional: working directory, useful for monorepos
working-directory: cli

# Optional: golangci-lint command line arguments.
# `golangci-lint-action` does not have an "install only" option.
# We ignore the output of this run, instead using it just to install the binary.
args: --issues-exit-code=0

- uses: pnpm/action-setup@v2.2.2
Expand Down
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,11 @@ If you're using a different package manager replace npm accordingly.

## Publishing `turbo` to the npm registry

Canary builds are automatically published when code is merged to the `main` branch.
See the [`release` Github workflow](./.github/workflows/release.yml).
All builds are handled by manually triggering the appropriate [`release` GitHub workflow](./.github/workflows/release.yml).

To manually release:
To manually run a release:

1. `brew install goreleaser`
2. Add `GORELEASER_KEY` env var with the Go Releaser Pro key (ask @turbo-oss to get access to the key)
2. Add `GORELEASER_KEY` env var with the GoReleaser Pro key (ask @turbo-oss to get access to the key)
3. Update `version.txt` (do not commit this change to git manually)
4. `cd cli && make publish`
2 changes: 2 additions & 0 deletions cli/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ publish: clean prepublish build
cd $(CLI_DIR)/../packages/create-turbo && npm publish --tag $(TURBO_TAG)
cd $(CLI_DIR)/../packages/turbo-codemod && npm publish --tag $(TURBO_TAG)

# Force push to ensure that the version used for the release is published.
# This _intentionally_ clobbers. If it does so, redo the clobbered thing.
git push -f origin main "v$(TURBO_VERSION)"

demo/lage: install
Expand Down

0 comments on commit e80d380

Please sign in to comment.