Skip to content

Commit c79cdc6

Browse files
update readme
1 parent e2afe9d commit c79cdc6

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

typescript/README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,45 @@ MIT
238238
## Tooling
239239

240240
- followed this for ts config setup: https://www.totaltypescript.com/tsconfig-cheat-sheet
241-
-
241+
242+
243+
## Release workflow
244+
245+
We using bumpp to bump package.json and lock, create git tag and commit
246+
1. Run:
247+
```
248+
npx bumpp
249+
```
250+
251+
2. You should see:
252+
```
253+
254+
4 Commits since the last version:
255+
256+
5217cd1 : update readme
257+
7a3c03d : Expose page delimiter
258+
e2791a4 : Merge branch 'main' of github.com:textcortex/JSON-DOC
259+
b7b30c1 : Make more typesafe
260+
261+
✔ Current version 0.2.0-alpha.3 › next 0.2.0-alpha.4
262+
263+
files package-lock.json
264+
package.json
265+
commit chore: release v0.2.0-alpha.4
266+
tag typescript-v0.2.0-alpha.4
267+
268+
from 0.2.0-alpha.3
269+
to 0.2.0-alpha.4
270+
```
271+
You can choose a different version from the list or create new one. But bumpp is smart enough to use appropriate next version.
272+
273+
3. Verify and confirm
274+
4. Push commit and tag
275+
5. The new tag will trigger a release on github actions.
276+
6. Go to github and create release using the new tag. Make sure you set the correct previous tag prefixed with `typescript-v`
277+
278+
279+
242280

243281
## Todos
244282

0 commit comments

Comments
 (0)