Skip to content

build: Add release-it #364

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.

Sign up for GitHub

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

Closed
abmusse wants to merge 4 commits into from
Closed

build: Add release-it #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5a14ed
build: Add release-it
abmusse Nov 30, 2022
0a1b0b2
fixup! build: Add release-it
abmusse Dec 7, 2022
0f0dfee
fixup! fixup! build: Add release-it
abmusse Dec 13, 2022
3694e96
Update .release-it.json
abmusse Dec 13, 2022
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
14 changes: 14 additions & 0 deletions .release-it.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"npm": {
"publish": false
},
"git": {
"requireBranch": "master",
"commitMessage": "chore: release ${version}"
},
"github": {
"release": true,
"autoGenerate": true,
"releaseName": "v${verison}"
}
}
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- [Tests](#tests)
- [Contributing](#contributing)
- [License](#license)
- [Release](#release)

# Introduction

Expand Down Expand Up @@ -97,3 +98,18 @@ Please read the [contribution guidelines](https://github.com/IBM/nodejs-itoolkit

# License
[MIT](https://github.com/IBM/nodejs-itoolkit/blob/master/LICENSE)


# Release

To generate a release use one of the npm scripts:

- patch release `npm run release`
- for other release types run `npm run release-it` which will prompt
you for the release type.

These scripts will bump the version number, make a release commit, tag the release, and finally create a github release if the user has `GITHUB_TOKEN` set.

Otherwise release-it will output a URL with all the fields pre-populated see the [release-it docs](https://github.com/release-it/release-it/blob/HEAD/docs/github-releases.md#manual).

After the release is published the [publish action](https://github.com/IBM/nodejs-idb-pconnector/blob/a4154bacf8e327e242c2d44e312079aea0690d8f/.github/workflows/publish.yml#L1) will publish to npm.
Loading