mirror of
https://github.com/socketio/socket.io.git
synced 2026-01-09 06:58:02 -05:00
docs: add release steps
[skip ci]
This commit is contained in:
11
packages/socket.io-client/RELEASING.md
Normal file
11
packages/socket.io-client/RELEASING.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Releasing
|
||||
|
||||
1. Update the version in `package.json`
|
||||
2. Update the version in `support/package.esm.json`
|
||||
3. Update the changelog `CHANGELOG.md` with `conventional-changelog -p angular`
|
||||
4. Compile the TypeScript sources with `npm run compile`
|
||||
5. Generate the bundles with `npm run build`
|
||||
6. Commit the changes in `package.json`, `support/package.esm.json`, `CHANGELOG.md` and `dist/`
|
||||
7. Create the tag `socket.io-client@x.y.z` and push it to the GitHub repository. The workflow `.github/workflows/publish.yml` will safely publish the package to npm using trusted publishing.
|
||||
8. Create a new release at https://github.com/socketio/socket.io/releases
|
||||
9. Copy the bundles to the repository https://github.com/socketio/socket.io-cdn so that they are available at https://cdn.socket.io/
|
||||
8
packages/socket.io/RELEASING.md
Normal file
8
packages/socket.io/RELEASING.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Releasing
|
||||
|
||||
1. Update the version in `package.json`
|
||||
2. Update the changelog `CHANGELOG.md` with `conventional-changelog -p angular`
|
||||
3. Copy the bundles from the client project to `client-dist/`
|
||||
4. Commit the changes in `package.json`, `CHANGELOG.md` and `client-dist/`
|
||||
5. Create the tag `socket.io@x.y.z` and push it to the GitHub repository. The workflow `.github/workflows/publish.yml` will safely publish the package to npm using trusted publishing.
|
||||
6. Create a new release at https://github.com/socketio/socket.io/releases
|
||||
Reference in New Issue
Block a user