Skip to content
This repository was archived by the owner on Apr 28, 2025. It is now read-only.

Commit e5614be

Browse files
committed
Updated release process documentation to include npm.
Part of issue stevenbenner#134.
1 parent 8d0d187 commit e5614be

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

doc/release-process.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The events that fire during the tooltip life cycle are also considered to be par
2929

3030
2. **Bump the version in package.json**
3131

32-
The package.json is used when building the project.
32+
The package.json is used when building the project and when publishing to npm.
3333

3434
3. **Run `grunt build:release`**
3535

@@ -51,6 +51,12 @@ The events that fire during the tooltip life cycle are also considered to be par
5151

5252
This is the fail-safe step. Make sure the build looks right. Make sure the commits from steps 1 and 2 are correct. Make sure the commits added to the gh-pages branch look right. If everything looks good then push the commits and the tag. With that the new version is out and available for download.
5353

54+
7. **Publish to npm**
55+
56+
First, verify that the package to be release to npm contains the expected files in the expected structure. Run `grunt build:npm && npm pack`. This will generate the appropriate dist folder contents and create the tgz package. Look over the tgz package to make sure everything looks good.
57+
58+
Now publish the new release to the npm repository by running the `npm publish` command. This will automatically run the `grunt build:npm` task via the npm precommit script.
59+
5460
7. **Add new release to GitHub repo**
5561

5662
Since the GitHub releases feature is a fairly recent addition this part of the process is still manual. Add a release for the tag, copy and paste the release notes, and add the zip archive to the release.

0 commit comments

Comments
 (0)