Skip to content

Commit 8ebdcda

Browse files
committed
update CHANGELOG
1 parent cc7eb68 commit 8ebdcda

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ cd my-app
5353

5454
1. Tag all merged pull requests that go into the release with the relevant milestone. Each merged PR should also be labeled with one of the [labels](https://github.com/ncphillips/create-typescript-package/labels) named `tag: ...` to indicate what kind of change it is.
5555
2. Close the milestone.
56-
4. Note that files in `packages/create-typescript-package` should be modified with extreme caution. Since it’s a global CLI, any version of `create-typescript-package` (global CLI) including very old ones should work with the latest version of `type-scripts`.
57-
5. Create a change log entry for the release:
56+
3. Note that files in `packages/create-typescript-package` should be modified with extreme caution. Since it’s a global CLI, any version of `create-typescript-package` (global CLI) including very old ones should work with the latest version of `type-scripts`.
57+
4. Create a change log entry for the release:
5858
* You'll need an [access token for the GitHub API](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Save it to this environment variable: `export GITHUB_AUTH="..."`
5959
* Run `npm run changelog`. The command will find all the labeled pull requests merged since the last release and group them by the label and affected packages, and create a change log entry with all the changes and links to PRs and their authors. Copy and paste it to `CHANGELOG.md`.
6060
* Add a four-space indented paragraph after each non-trivial list item, explaining what changed and why. For each breaking change also write who it affects and instructions for migrating existing code.
6161
* Maybe add some newlines here and there. Preview the result on GitHub to get a feel for it. Changelog generator output is a bit too terse for my taste, so try to make it visually pleasing and well grouped.
62-
6. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
63-
7. **Do not run `npm publish`. Instead, run `npm run publish`.**
64-
8. Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
65-
9. After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.
62+
5. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
63+
6. **Do not run `npm publish`. Instead, run `npm run publish`.**
64+
7. Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
65+
8. After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.
6666

6767
Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --tag next` instead of `npm run publish`.

0 commit comments

Comments
 (0)