https://github.com/libuv/libuv-release-tool
Tool for making libuv releases
https://github.com/libuv/libuv-release-tool
Last synced: about 1 year ago
JSON representation
Tool for making libuv releases
- Host: GitHub
- URL: https://github.com/libuv/libuv-release-tool
- Owner: libuv
- Created: 2013-04-09T23:37:23.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2023-11-06T19:45:13.000Z (over 2 years ago)
- Last Synced: 2025-04-03T12:55:24.550Z (about 1 year ago)
- Language: JavaScript
- Homepage: http://libuv.org
- Size: 119 KB
- Stars: 12
- Watchers: 16
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# libuv-release-tool
Command line utility for creating new releases of libuv.
## Making a release
1. Make sure you have the most up-to-date version of this tool and the libuv
branch that will be used to create the release.
2. Currently, the release tool requires Node.js v12 or later. You may want to
use something like `nvm` to change Node versions.
3. Run `node ./release.js --version x.x.x --dir path --remote name`, where
`x.x.x` is the version of libuv you are creating, `path` is the location of
the libuv core repository on your machine, and `name` is the libuv core git
remote. This will perform a few tasks, such as updating the libuv `AUTHORS`
file if necessary. Review any changes made to libuv before continuing.
4. Run `node ./release.js --version x.x.x --dir path --remote name --continue`.
`x.x.x`, `path`, and `name` have the same meaning as in the previous step. The
`--continue` flag tells the release tool to continue work on the release started
in the previous step. If you need to cancel a release that has been started, you
can substitute `--abort` for `--continue` at any time. At this time, you should
see the CHANGELOG for the proposed release. Review the CHANGELOG for
correctness. Remove the first commit, which should mention adding the SHA to
CHANGELOG. Optionally, you may remove any commits that were made and then
reverted in this release, as they cancel each other out. Once the CHANGELOG
looks good, save the changes. You will also need to sign the release using your
GPG key.
5. Run `node ./release.js --version x.x.x --dir path --remote name --continue`
again. This updates the website, pushes the tag and branch, signs the tarball,
etc. You can verify that this step worked by checking
`http://dist.libuv.org/dist/vx.x.x`, which should include `.tar.gz` and
`.tar.gz.sign` files.
6. Create a "Now working on" commit in libuv/libuv. An example can be seen
[here](https://github.com/libuv/libuv/commit/07955ed3737cc59bc4d586b34222669ca87de755).
7. Create a new release on Github for the tag at
.
8. Optionally, make a pull request to nodejs/node to update the version of libuv.
At the time of writing, the Node.js project has automation in place to update its
libuv dependency.