@planoly/planogram-config 1.0.0-beta.1 → 1.0.0-beta.2
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 +31 -8
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +3 -2
- package/postExperienceConfig.json +1 -1
package/README.md
CHANGED
|
@@ -96,16 +96,39 @@ postExperienceConfig
|
|
|
96
96
|
1. Edit `postExperienceConfig.json`
|
|
97
97
|
2. Create a PR and get review
|
|
98
98
|
3. Merge to main
|
|
99
|
-
4.
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
99
|
+
4. Create a release (see below)
|
|
100
|
+
|
|
101
|
+
### Creating a Release
|
|
102
|
+
|
|
103
|
+
Use `npm version` to bump versions - it automatically keeps `package.json` and `postExperienceConfig.json` in sync:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
# Bump version (choose one)
|
|
107
|
+
npm version patch # 1.0.0 → 1.0.1 (bug fixes, typos)
|
|
108
|
+
npm version minor # 1.0.0 → 1.1.0 (new platforms, features)
|
|
109
|
+
npm version major # 1.0.0 → 2.0.0 (breaking changes)
|
|
110
|
+
|
|
111
|
+
# Or set explicit version
|
|
112
|
+
npm version 1.2.3
|
|
113
|
+
|
|
114
|
+
# Push changes and tag
|
|
115
|
+
git push origin main --tags
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
This will:
|
|
119
|
+
1. Update `package.json` version
|
|
120
|
+
2. Run `scripts/sync-version.cjs` → syncs `postExperienceConfig.json`
|
|
121
|
+
3. Commit both files
|
|
122
|
+
4. Create git tag (e.g., `v1.2.3`)
|
|
123
|
+
|
|
124
|
+
The Bitbucket pipeline then auto-publishes to npm when it sees the tag.
|
|
105
125
|
|
|
106
126
|
### Versioning Guidelines
|
|
107
127
|
|
|
108
|
-
|
|
128
|
+
Follow [semver](https://semver.org/):
|
|
129
|
+
- **Patch** (`1.0.x`): Bug fixes, typo corrections in messages
|
|
130
|
+
- **Minor** (`1.x.0`): New platforms, new post types, new validation rules
|
|
131
|
+
- **Major** (`x.0.0`): Breaking changes to config structure
|
|
109
132
|
|
|
110
133
|
## Development
|
|
111
134
|
|
|
@@ -143,7 +166,7 @@ Set a calendar reminder to rotate the token before expiration:
|
|
|
143
166
|
2. Update the `NPM_TOKEN` repository variable in Bitbucket
|
|
144
167
|
3. Delete the old token from npm
|
|
145
168
|
|
|
146
|
-
@planoly organization created on npm by
|
|
169
|
+
@planoly organization created on npm by David H - eventually need to transfer org to more official account
|
|
147
170
|
|
|
148
171
|
## License
|
|
149
172
|
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@planoly/planogram-config",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.2",
|
|
4
4
|
"description": "Centralized configuration for Planoly post experience across all platforms",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
},
|
|
19
19
|
"scripts": {
|
|
20
20
|
"build": "tsup src/index.ts --format esm --dts",
|
|
21
|
-
"prepublishOnly": "npm run build"
|
|
21
|
+
"prepublishOnly": "npm run build",
|
|
22
|
+
"version": "node scripts/sync-version.cjs && git add postExperienceConfig.json"
|
|
22
23
|
},
|
|
23
24
|
"repository": {
|
|
24
25
|
"type": "git",
|