Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): add release docs for turborepo #3032

Merged
merged 1 commit into from
Dec 16, 2022
Merged

feat(docs): add release docs for turborepo #3032

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 15 additions & 1 deletion release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Release packages
# Release Documentation

## Release npm packages

Expand Down Expand Up @@ -43,3 +43,17 @@ Once you have finished the bump, the script will do the following things:
- run `git tag -s pkg@version -m "pkg@version"` for each package

You need to run `git push --follow-tags` to finish the release.

## Release Turborepo

We have a multi step release process for Turborepo right now.

**NOTE**: The steps below _must_ be run serially, in the order specified.

1. Create a release branch by triggering the [Create Release Branch](https://github.com/vercel/turbo/actions/workflows/stage.yml) workflow
1. Specify the semver increment using the SemVer Increment field
2. Build the Go Library by triggering the [Build Go Library](https://github.com/vercel/turbo/actions/workflows/build_go_lib.yml) workflow.
1. Specify the release branch (example: `staging-1.7.0-canary.1`) in _both_ the "use workflow from", and "Staging branch to release from" fields.
3. Build the Rust Wrapper by triggering the [Build Rust Wrapper](https://github.com/vercel/turbo/actions/workflows/build_rust.yml) workflow.
1. Specify the release branch (example: `staging-1.7.0-canary.1`) in _both_ the "use workflow from", and "Staging branch to release from" fields. (this should match step 2.1 above)
4. Open a PR and merge the release branch back into `main`