@commversion/libs 0.12.0-pre.0 → 0.12.0
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 +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -46,6 +46,21 @@ All scripts are available under the `scripts/` directory.
|
|
|
46
46
|
|
|
47
47
|
## Release new versions
|
|
48
48
|
|
|
49
|
+
**Important**
|
|
50
|
+
This project uses the npm.js public registry. Before trying to do any release, make sure you are logged with npm as Commversion.
|
|
51
|
+
The quickest way to do that, is to create a `.npmrc` file in the project directly and insert the following:
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
//registry.npmjs.org/:_authToken=base64_encoded_npm_token
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
You can test if the above works by running:
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
$ npm whoami
|
|
61
|
+
commversion # this is the authenticated npm user
|
|
62
|
+
```
|
|
63
|
+
|
|
49
64
|
The project follows the semantic versioning convention.
|
|
50
65
|
|
|
51
66
|
Patch releases for bug fixes.
|
|
@@ -65,3 +80,9 @@ $ npx hygen scripts new script-name
|
|
|
65
80
|
The command above will create e new script containing the absolute minimum files. It will also amend root `README.md` and `package.json` to include required entries.
|
|
66
81
|
|
|
67
82
|
Start working on a specific script by running `npm run package:dev`.
|
|
83
|
+
|
|
84
|
+
Finally, you can run tests by running:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
$ npm test
|
|
88
|
+
```
|