@constructor-io/constructorio-ui-autocomplete 1.14.1 → 1.15.1
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 +24 -5
- package/dist/constructorio-ui-autocomplete-bundled.js +8 -8
- package/lib/cjs/constants.js +2 -1
- package/lib/cjs/hooks/useCioAutocomplete.js +2 -2
- package/lib/cjs/hooks/useCioClient.js +2 -2
- package/lib/cjs/hooks/useDebouncedFetchSections.js +1 -1
- package/lib/cjs/utils.js +3 -7
- package/lib/cjs/version.js +1 -1
- package/lib/mjs/constants.js +1 -0
- package/lib/mjs/hooks/useCioAutocomplete.js +2 -2
- package/lib/mjs/hooks/useCioClient.js +2 -2
- package/lib/mjs/hooks/useDebouncedFetchSections.js +1 -1
- package/lib/mjs/utils.js +3 -2
- package/lib/mjs/version.js +1 -1
- package/lib/types/constants.d.ts +1 -0
- package/lib/types/types.d.ts +2 -1
- package/lib/types/utils.d.ts +2 -2
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -4
package/README.md
CHANGED
|
@@ -195,12 +195,31 @@ npm run dev # start a local dev server for Storybook
|
|
|
195
195
|
npm run lint # run linter
|
|
196
196
|
```
|
|
197
197
|
|
|
198
|
-
|
|
198
|
+
## Publishing new versions
|
|
199
|
+
|
|
200
|
+
Dispatch the [Publish](https://github.com/Constructor-io/constructorio-ui-autocomplete/actions/workflows/publish.yml) workflow in GitHub Actions. You're required to provide two arguments:
|
|
201
|
+
- **Version Strategy**: `major`, `minor`, or `patch`.
|
|
202
|
+
- **Title**: A title for the release.
|
|
203
|
+
|
|
204
|
+
This workflow will automatically:
|
|
205
|
+
1. Bump the library version using the provided strategy.
|
|
206
|
+
2. Create a new git tag.
|
|
207
|
+
3. Create a new GitHub release.
|
|
208
|
+
4. Compile the library.
|
|
209
|
+
5. Publish the new version to NPM.
|
|
210
|
+
6. Publish the new version to our public CDN.
|
|
211
|
+
7. Deploy the Storybook docs to GitHub Pages.
|
|
212
|
+
8. Report the progress on the [relevant Slack channel](https://constructor.slack.com/archives/C061D3CFVR9).
|
|
213
|
+
|
|
214
|
+
#### ℹ️ Note: Please don't manually increase the package.json version or create new git tags.
|
|
215
|
+
The library version is tracked by releases and git tags. We intentionally keep the package.json version at `0.0.0` to avoid pushing changes to the `main` branch. This solves many security concerns by avoiding the need for branch-protection rule exceptions.
|
|
216
|
+
|
|
217
|
+
## New Storybook Version
|
|
218
|
+
|
|
219
|
+
Dispatch the [Deploy Storybook](https://github.com/Constructor-io/constructorio-ui-autocomplete/actions/workflows/deploy-storybook.yml) workflow in GitHub Actions.
|
|
220
|
+
|
|
221
|
+
#### ℹ️ Note: This is already done automatically when publishing a new version.
|
|
199
222
|
|
|
200
|
-
```bash
|
|
201
|
-
npm run compile # generate lib folder for publishing to npm
|
|
202
|
-
npm run build-storybook # generate storybook static bundle for deploy with GH Pages
|
|
203
|
-
```
|
|
204
223
|
|
|
205
224
|
## Supporting Docs
|
|
206
225
|
|