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

docs: fix automating-changesets.md typo & grammar #917

Merged
merged 1 commit into from Aug 16, 2022
Merged
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions docs/automating-changesets.md
@@ -1,6 +1,6 @@
# Automating Changesets

While changesets is designed to work with a fully manual process, it also provides tools to help automate these releases. These can be broken into two major decisions:
While changesets are designed to work with a fully manual process, it also provides tools to help automate these releases. These can be broken into two major decisions:

1. How do I want to ensure pull requests have changesets?
2. How do I run the version and publish commands?
Expand All @@ -14,7 +14,7 @@ Here we have a quick-start recommended workflow, with more

## How do I want to ensure pull requests have changesets?

Changesets are committed to files, and so a diligent reviewer can always technically tell if a changeset is absent and request one be added. As humans though, a file not being there is easy to miss. We recommend adding some way to detect the presence or absence of changesets on a pull request so you don't have to, as well as highlight it to pull-request makers so you don't have to.
Changesets are committed to files, so a diligent reviewer can always technically tell if a changeset is absent and request one be added. As humans though, a file not being there is easy to miss. We recommend adding some way to detect the presence or absence of changesets on a pull request so you don't have to, as well as highlight it to pull-request makers so you don't have to.

This has two main approaches.

Expand All @@ -24,15 +24,15 @@ In this approach, a pull request may be merged if no changeset is present, and a

### Blocking

In some cases, you may want to make CI fail if not changeset is present, to ensure no PR can be merged without a changeset. To do this:
Sometimes, you may want to make CI fail if no changeset is present to ensure no PR can be merged without a changeset. To do this:

In your CI process add a step that runs:
In your CI process, add a step that runs:

```bash
changeset status --since=main
```

This will exit with the exit code 1 if there have been no new changesets since master.
This will exit with exit code 1 if there have been no new changesets since master.

In some cases, you may _want_ to merge a change without doing any releases (such as when you only change tests or build tools). In this case, you can run `changeset --empty`. This will add a special changeset that does not release anything.

Expand All @@ -46,10 +46,10 @@ We have a [github action](https://github.com/changesets/action) that
If you don't want to use this action, the manual workflow we recommend for running the `version` and `publish` commands is:

- A release coordinator (RC) calls to stop any merging to the base branch
- The RC pull down the base branch, runs `changeset version`, then make a new PR with the versioning changes
- The RC pulls down the base branch, runs `changeset version`, then makes a new PR with the versioning changes
- The versioning changes are merged back into the base branch
- The RC pulls the base branch again and runs `changeset publish`
- The RC runs `git push --follow-tags` to push the release tags back
- The RC unblocks merging to the base branch

This is a lot of steps, and is quite finnicky (we have to pull from the base branch twice). Feel free to finesse it to your own circumstances.
This is a lot of steps and is quite finicky (we have to pull from the base branch twice). Feel free to finesse it to your own circumstances.