Skip to content

Commit fd5e476

Browse files
authored
Update PUBLISH.md (#326)
1 parent f210603 commit fd5e476

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

PUBLISH.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
**We use the `xyz` NPM package to simplify releases. This library uses a feature that is available in Bash 4 or beyond, but latest versions of macOS
44
ship with an older version of Bash. If you run into issues with `xyz`, use `brew install bash` to install a newer verison of Bash.**
55

6+
If you run into any `npm` package versioning issues, make sure you run `make setup` rather than calling `npm install` directly.
7+
68
1. Create a branch to stage the release, for example `release-3.4.5` (Read [semver](https://semver.org/) to determine what type of version bump to use.)
79

810
```
@@ -25,16 +27,20 @@ make release-(patch|minor|major)
2527

2628
5. Merge the branch
2729

28-
#### **Manually publish to NPM**
30+
#### **If the `make` command errors out with an authentication issue**
2931

3032
If `make release-*` from above errors out with an authentication issue,
3133
you may need to `npm login` or otherwise manually set up your `~/.npmrc` file to
3234
make sure you have access to publish to npm.
3335

34-
Once you have done that, the following command will publish the latest version
35-
(already bumped and pushed in step 4) to the NPM registry:
36+
#### (dangerous) Manually publish an already-built package to npm
37+
38+
If you've set up your npm authentication as described above, but are still seeing authentication issues when running `make release-*`, you can
39+
directly publish a **built** package to the npm registry using the manual commands below. You should **only** publish the package manually using these steps
40+
if the build steps of the `make release-*` command were **successful**. If the build steps did not succeeed, running these commands could publish an unbuilt
41+
version of the package, which would lead to a broken release.
3642

37-
1. Publish to npm manually
43+
1. Publish already-built package to npm manually
3844

3945
```bash
4046
npm --registry=https://registry.npmjs.com publish

0 commit comments

Comments
 (0)