Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/egoist/kanpai

:beers: Kanpai is a better way to publish npm packages.
https://github.com/egoist/kanpai

pr-welcome

Last synced: 2 months ago
JSON representation

:beers: Kanpai is a better way to publish npm packages.

Host: GitHub
URL: https://github.com/egoist/kanpai
Owner: egoist
License: mit
Created: 2016-02-11T08:55:12.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2022-08-17T07:47:13.000Z (almost 2 years ago)
Last Synced: 2024-04-08T17:15:02.508Z (3 months ago)
Topics: pr-welcome
Language: TypeScript
Homepage:
Size: 1.23 MB
Stars: 111
Watchers: 3
Forks: 4
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-stars - kanpai - :beers: Kanpai is a better way to publish a new version of your node module! (JavaScript)

README

## How it works

**No black magic**. In [semantic-release](https://github.com/semantic-release/semantic-release) you don't have full control of project publish, `semantic-release` smartly analyze your commits and publish the corresponding new version.

While using `kanpai` (shortened to `kp`), you specify the version to publish instead. By running `kp [patch|minor|major|x.y.z]`, it does following things:

- Check git status, see if you have committed the changes and if the remote history differs.
- Run tests, `npm test` by default.
- Update package version, `CHANGELOG.md`, create git tag as well.
- Push to remote git server

After that, you can publish the npm package and create GitHub Release with the `kp release` command. And this step can be automated via CI like GitHub Actions and CircleCI.

## Install

```bash
$ npm install -g kanpai

# or use yarn
$ yarn global add kanpai
```

## Usage

```bash
$ kp [patch|minor|major|$version|pre$type]

# custom test command, equal to npm run test:other
$ kp --test test:other

# skip test script
$ kp --skip-test

# more usages
$ kp -h
```

A common workflow:

```bash
# after hack something...
$ git commit -am "change the world"
$ kp

# On CI
$ kp release
```

## Config

Some CLI flags can be configured via `kanpai.json` file:

```
{
"test": "lint", // custom test script => npm run lint
"commitMessage": "Release version %s"
}
```

## Keep a `CHANGELOG.md`

Running `kp` will also generate a `CHANGELOG.md` file, which will include the changes since last release:

```markdown
## Unreleased

No unreleased changes.

## 0.1.0

- Some commit message
```

As you can see this file also includes an "Unreleased" section, and upon running `kp` the content will be automatically replaced by the commit messages since last release, and the heading `## Unreleased` will be updated to the actual version number.

You can also write the "Unreleased" section manually, the content will only be replaced by commit messages if the heading is followed by nothing or another h2 heading. In this case only the heading will be replaced.

## FAQ

### fatal: no upstream configured for branch 'master'

Two options:

a) `git branch --set-upstream-to=origin/master master` and then run `git push`

b) `git push -u origin master`

## License