@lokiengineering/loki-common-node 0.0.1-rc → 1.0.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 +8 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -141,15 +141,20 @@ dist/ # Compiled output (generated)
|
|
|
141
141
|
|
|
142
142
|
### Publish a Release
|
|
143
143
|
|
|
144
|
-
|
|
144
|
+
**Requirements:**
|
|
145
|
+
- Tag must be created on `main` branch (or after merging to main)
|
|
146
|
+
- The version must match in both `package.json` and git tag
|
|
147
|
+
|
|
148
|
+
**Steps:**
|
|
145
149
|
|
|
146
150
|
1. Update the version in `package.json` (e.g., `0.1.0`)
|
|
147
|
-
2. Commit and push to main
|
|
148
|
-
3. Create a git tag
|
|
151
|
+
2. Commit and push to main: `git push origin main`
|
|
152
|
+
3. Create a git tag from main: `git tag v0.1.0`
|
|
149
153
|
4. Push the tag: `git push origin v0.1.0`
|
|
150
154
|
5. GitHub Actions automatically builds and publishes to npm
|
|
151
155
|
|
|
152
156
|
The workflow will:
|
|
157
|
+
- ✓ Verify the tag exists on the main branch
|
|
153
158
|
- ✓ Verify that `package.json` version matches the git tag
|
|
154
159
|
- ✓ Build TypeScript
|
|
155
160
|
- ✓ Run type checking and formatting checks
|