From 4a88655905dca69677a5239329e054bab20a2e18 Mon Sep 17 00:00:00 2001 From: vladislav doster <10052309+vladdoster@users.noreply.github.com> Date: Mon, 15 Aug 2022 18:16:25 -0500 Subject: [PATCH] docs: fix typo & grammar in automating-changesets.md - `finnicky` -> `finicky` - remove unnecessary comma - correct subject-verb agreement - correct verb form - correct article usage --- docs/automating-changesets.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/automating-changesets.md b/docs/automating-changesets.md index 2bbdc708c..fd54332d9 100644 --- a/docs/automating-changesets.md +++ b/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? @@ -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. @@ -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. @@ -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.