Skip to content

Commit 950166b

Browse files
committed
Update RELEASE doc
1 parent 9f2a12b commit 950166b

File tree

1 file changed

+4
-29
lines changed

1 file changed

+4
-29
lines changed

RELEASE.md

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
# Robot Web Tools Module Release TODOs
2-
3-
This document describes TODOs and checklists in order to release
4-
Robot Web Tool javascript modules([roslibjs](https://github.com/RobotWebTools/roslibjs), [ros2djs](https://github.com/RobotWebTools/ros2djs), [ros3djs](https://github.com/RobotWebTools/ros3djs)).
1+
# How to release roslibjs
52

63
## 0. Make sure that the releasing module is compatible with other RWT modules
74

@@ -13,36 +10,14 @@ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator
1310

1411
## 2. Bump a new version
1512

16-
* Version bump in package.json, bower.json, and in the main file. e.g) [RosLib.js](src/RosLib.js)
13+
* Version bump in [package.json](./package.json)
1714
* Tag the version
1815

19-
## 3. Release modules
20-
21-
### NPM
22-
23-
Publish the module. We publish in the global scope.
24-
25-
* `npm publish`
26-
27-
### CDN
28-
29-
Hosted via the [JsDelivr](https://www.jsdelivr.com/) CDN, which takes it directly from the repo.
30-
31-
## 4. Create GitHub Release
16+
## 3. Create GitHub Release
3217

3318
* Create a new GitHub release based on the new git tag.
3419
* Add the version number as release title (Without leading `v`).
3520
* Let GitHub auto-generate the Changelog
3621
* Mark `Set as latest release`
3722
* Publish release
38-
39-
## 5. Update JSdocs in Robot Web Tools website
40-
41-
The JSdocs are update automatically by GitHub Actions [config](.github/workflows/docs.yml). The GitHub release created above, will trigger this run. The docs are hosted in their own repository at the `gh-pages` branch.
42-
43-
## 6. Sync `develop` branch with `master`
44-
45-
`Master` branch should represent the latest release.
46-
47-
* Create a PR against `master` from `develop`
48-
* Do *Rebase and merge* to have the same history as `develop` branch
23+
* [The CD action](.github/workflows/cd.yml) will automatically publish the docs to the website and publish the package to npm.

0 commit comments

Comments
 (0)