Skip to content

Commit 39bb720

Browse files
docs: add release steps
[skip ci]
1 parent 98741e1 commit 39bb720

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Releasing
2+
3+
1. Update the version in `package.json`
4+
2. Update the version in `support/package.esm.json`
5+
3. Update the changelog `CHANGELOG.md` with `conventional-changelog -p angular`
6+
4. Compile the TypeScript sources with `npm run compile`
7+
5. Generate the bundles with `npm run build`
8+
6. Commit the changes in `package.json`, `support/package.esm.json`, `CHANGELOG.md` and `dist/`
9+
7. Create the tag `[email protected]` and push it to the GitHub repository. The workflow `.github/workflows/publish.yml` will safely publish the package to npm using trusted publishing.
10+
8. Create a new release at https://github.com/socketio/socket.io/releases
11+
9. Copy the bundles to the repository https://github.com/socketio/socket.io-cdn so that they are available at https://cdn.socket.io/

packages/socket.io/RELEASING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Releasing
2+
3+
1. Update the version in `package.json`
4+
2. Update the changelog `CHANGELOG.md` with `conventional-changelog -p angular`
5+
3. Copy the bundles from the client project to `client-dist/`
6+
4. Commit the changes in `package.json`, `CHANGELOG.md` and `client-dist/`
7+
5. Create the tag `[email protected]` and push it to the GitHub repository. The workflow `.github/workflows/publish.yml` will safely publish the package to npm using trusted publishing.
8+
6. Create a new release at https://github.com/socketio/socket.io/releases

0 commit comments

Comments
 (0)