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.

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

Update release docs #1366

Merged
merged 1 commit into from
May 27, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,29 @@ yarn add @shopify/hydrogen@unstable
npx create-hydrogen-app@unstable
```

## Releasing experimental versions

Sometimes, you might want to publish the latest version of the main branch as an NPM release to test in standalone apps. Or you want to test a new, unmerged feature in an NPM release.

To do so, you can merge your code into the `experimental` branch. Feel free to "recycle" the existing branch (delete it or force-push your code). Since NPM releases are permanent, existing developers working on a previously-released experimental version will be bound to the timestamped release number.

> Note:
> The `experimental` branch should be treated as ephemeral, and you should NOT develop your features directly in the branch. Instead, use a separate feature branch and merge it into `experimental` to perform releases.

To release an experimental version:

1. Merge your changes into the `experimental` branch.
2. Visit the Shipit page for `Hydrogen Experimental` and click **Deploy** on the commit you want to release

A new snapshot release will be created with your changes and tagged on NPM with `experimental`. You can install the experimental version of Hydrogen using this tag:

```bash
yarn add @shopify/hydrogen@experimental

# or start a new project:
npx create-hydrogen-app@experimental
```

## Common problems

**After merging the auto-generated changeset PR, my GitHub Action encountered an Error with the message `No commits between X and changeset-release/Y`**
Expand Down