Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: how to create a new release. #18

Merged
merged 1 commit into from
Mar 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions CREATING_A_RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Creating a release

Only collaborators in npm for **node-api-headers** can create releases. If you
want to be able to do releases ask one of the existing collaborators to add
you. If necessary you can ask the build Working Group who manages the Node.js
npm user to add you if there are no other active collaborators.

## Prerequisites

Before to start creating a new release check if you have installed the following
tools:

* [Changelog maker](https://www.npmjs.com/package/changelog-maker)

If not please follow the instruction reported in the tool's documentation to
install it.

## Publish new release

These are the steps to follow to create a new release:

* Open an issue in the **node-api-headers** repo documenting the intent to
create a new release. Give people some time to comment or suggest PRs that
should land first.

* Update the version in **package.json** appropriately.

* Update the [README.md][] to show the latest stable version of Node-API.

* Generate the changelog for the new version using **changelog maker** tool.
From the root folder of the repo launch the following command:

```bash
> changelog-maker --format=markdown
```

* Use the output generated by **changelog maker** to update the
[CHANGELOG.md][] following the style used in publishing the previous release.

* Add any new contributors to the "contributors" section in the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't find steps to create git tags for the release. Should we document that the tag should be created along with package.json version updates by npm version patch or npm version minor?

Copy link
Member Author

@NickNaso NickNaso Mar 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tag will be created by GitHub while creating new release.
This will be address doing this step:

  • Create a release in Github (look at existing releases for an example).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, SGTM.

**package.json**.

* Do a clean checkout of `node-api-headers`.

* Login and then run `npm publish`.

* Create a release in Github (look at existing releases for an example).

* Validate that you can run `npm install node-api-headers` successfully
and that the correct version is installed.

* Comment on the issue opened in the first step that the release has been created
and close the issue.

* Tweet that the release has been created.

[README.md]: ./README.md
[CHANGELOG.md]: ./CHANGELOG.md
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- **[Code of Conduct](CODE_OF_CONDUCT.md)**
- **[Install](#install)**
- **[API](#api)**
- **[Creating a release](CREATING_A_RELEASE.md)**
- **[Team](#team)**
- **[License](#license)**

Expand Down