@wellcometrust/wellcome-icons 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -42,4 +42,29 @@ Running `nvm use` from the command line will automatically pick up the version n
|
|
|
42
42
|
|
|
43
43
|
### Publishing for consumption
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
Once a pull request with the necessary changes is merged, the developer:
|
|
46
|
+
|
|
47
|
+
1. Checks out a new branch, the name isn't particularly important, something appropriate such as `git checkout -b task/updates-version` is fine.
|
|
48
|
+
2. Ensure the dependencies are up-to-date, run `npm ci`.
|
|
49
|
+
3. Set the package version using the npm cli:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
npm version <major|minor|patch> -m "Released version %s: <brief_description>"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
4. Runs the following command to publish the new version of the package:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
npm publish --access public
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
5. Push the branch *and the tags* to the Github repo:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
git push -u origin <branch_name> --follow-tags
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
6. Create a pull request against `main`, request a review from other developers
|
|
68
|
+
7. Once approved, merge the pull request into `main`.
|
|
69
|
+
|
|
70
|
+
You can now `npm install @wellcometrust/wellcome-icons@{version_number|latest}` to use the new version in your project.
|