@allthings/structured-ticket-form 7.0.3 → 7.0.4

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.
Files changed (2) hide show
  1. package/README.md +41 -5
  2. package/package.json +9 -7
package/README.md CHANGED
@@ -28,7 +28,7 @@ Simple component to create and edit jsonSchemaForm with possibility to adding tr
28
28
  To use this component, install in your project using npm:
29
29
 
30
30
  ```
31
- $ npm install @allthings/structured-ticket-form
31
+ $ yarn install @allthings/structured-ticket-form
32
32
 
33
33
  ```
34
34
 
@@ -114,7 +114,43 @@ You can try out how it works using our Sandbox View.
114
114
 
115
115
  ## Deployment
116
116
 
117
- ```sh
118
- $ yarn version
119
- $ yarn release
120
- ```
117
+ ### Production release
118
+
119
+ !! DO NOT `npm version` !!
120
+
121
+ The project use [semantic-release](https://github.com/semantic-release/semantic-release) which automates the whole package release workflow including:
122
+
123
+ - determining the next version number
124
+ - generating the release notes and publishing the package
125
+
126
+ This repository is also configured to `squash-merge` ([see here](https://github.blog/2016-04-01-squash-your-commits/)).
127
+ When you squash merge, GitHub takes the title of the PR for the squash-merge's commit subject.
128
+
129
+ By choosing a proper PR title e.g. `feat: my new feature` your merged PR will trigger a new release.
130
+ See semantic-releases [docs](https://github.com/semantic-release/semantic-release#how-does-it-work) for available prefixes.
131
+
132
+ ### Development release
133
+
134
+ 1. **Create or check out the target branch** from the commit you want to release.
135
+
136
+ 2. **Push the branch** to trigger the CI pipeline:
137
+
138
+ ```sh
139
+ git push --force origin HEAD:beta # or alpha / next
140
+ ```
141
+
142
+ The pipeline will automatically run `semantic-release`, which detects the branch name, bumps the version with the appropriate pre-release tag, and publishes it to npm under the matching dist-tag. Check [Actions page](https://github.com/allthings/structured-ticket-form/actions) for the release logs.
143
+
144
+ 3. **Install the pre-release** in another project:
145
+
146
+ ```sh
147
+ yarn add -E @allthings/structured-ticket-form@beta # or @alpha / @next
148
+ ```
149
+
150
+ or use exact release (check [versions on npm](https://www.npmjs.com/package/@allthings/structured-ticket-form?activeTab=versions)):
151
+
152
+ ```sh
153
+ yarn add -E @allthings/structured-ticket-form@x.x.x-beta.x
154
+ ```
155
+
156
+ 4. **Promote to stable** – once the pre-release is validated, create a PR form your target branch and proceed with [Production release](#production-release) section.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@allthings/structured-ticket-form",
3
- "version": "7.0.3",
4
- "description": "Simple component to create and edit jsonSchemaForm with possibility to adding translated fields and custom UISchema.",
3
+ "version": "7.0.4",
4
+ "description": "Component to create and edit jsonSchemaForm with possibility to adding translated fields and custom UISchema.",
5
5
  "type": "module",
6
6
  "main": "./lib/index.js",
7
7
  "module": "./lib/index.js",
@@ -32,13 +32,16 @@
32
32
  "private": false,
33
33
  "repository": {
34
34
  "type": "git",
35
- "url": "git+https://github.com/allthings/structured-ticket-form"
35
+ "url": "git@github.com:allthings/structured-ticket-form.git"
36
36
  },
37
37
  "engines": {
38
38
  "node": "^22.13",
39
39
  "npm": ">=10"
40
40
  },
41
41
  "packageManager": "yarn@1.22.22",
42
+ "release": {
43
+ "repositoryUrl": "https://github.com/allthings/structured-ticket-form.git"
44
+ },
42
45
  "author": "Allthings",
43
46
  "license": "MIT",
44
47
  "bugs": {
@@ -54,13 +57,11 @@
54
57
  "prepare": "husky",
55
58
  "prettier": "prettier --write",
56
59
  "preversion": "yarn lint",
57
- "release": "yarn build && yarn publish --new-version $npm_package_version --tag latest --access public && git push --tags origin HEAD",
58
- "release:dev": "yarn build && yarn publish --new-version $npm_package_version --tag dev --access public",
59
60
  "security-check": "yarn audit --groups dependencies --level high || test $? -lt 7",
61
+ "semantic-release": "semantic-release",
60
62
  "start": "parcel src/index.html --target sandbox --no-cache --open",
61
63
  "test": "jest --passWithNoTests",
62
- "test:watch": "jest --watch",
63
- "up": "yarn upgrade-interactive --latest --exact"
64
+ "test:watch": "jest --watch"
64
65
  },
65
66
  "dependencies": {
66
67
  "@emotion/react": "^11.13.3",
@@ -95,6 +96,7 @@
95
96
  "react": "18.3.1",
96
97
  "react-dom": "18.3.1",
97
98
  "rimraf": "6.1.3",
99
+ "semantic-release": "25.0.3",
98
100
  "ts-jest": "29.4.6",
99
101
  "ts-patch": "3.3.0",
100
102
  "typescript": "5.9.3",