@embeddable.com/init 0.1.16 → 0.1.17
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 +6 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -59,31 +59,14 @@ npx <path-to-this-repo>
|
|
|
59
59
|
|
|
60
60
|
## Publishing to npm
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
Publishing happens automatically when code is merged to `main`. The GitHub Action will:
|
|
63
63
|
|
|
64
|
-
1.
|
|
65
|
-
2.
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
```
|
|
64
|
+
1. Build the package
|
|
65
|
+
2. Bump the patch version
|
|
66
|
+
3. Publish to npm
|
|
67
|
+
4. Push the version bump commit back to the repo
|
|
69
68
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
1. Update the version in `package.json`:
|
|
73
|
-
```bash
|
|
74
|
-
npm version patch # or minor/major
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
2. Publish to npm:
|
|
78
|
-
```bash
|
|
79
|
-
npm publish --access public
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
The `prepublishOnly` script will automatically run the build before publishing.
|
|
83
|
-
|
|
84
|
-
### Verifying the release
|
|
85
|
-
|
|
86
|
-
After publishing, verify the package is available:
|
|
69
|
+
To verify a release:
|
|
87
70
|
|
|
88
71
|
```bash
|
|
89
72
|
npm view @embeddable.com/init
|