# release-pkg

> - release your package easily!

Latest version **1.2.1** (published 2023-06-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install release-pkg
pnpm add release-pkg
yarn add release-pkg
bun add release-pkg
```

Provides the command `release-pkg`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2023-06-13 |
| First published | 2022-10-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.16.0 |
| Dependencies | 7 |
| Unpacked size | 6.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | pengbo-study |

## Links

- npm: https://www.npmjs.com/package/release-pkg
- Repository: https://github.com/PengBoUESTC/release-pkg
- Homepage: https://github.com/PengBoUESTC/release-pkg#readme
- Issues: https://github.com/PengBoUESTC/release-pkg/issues
- npm.io page: https://npm.io/package/release-pkg

## Dependencies (7)

- [tsm](https://npm.io/package/tsm.md) ^2.2.2
- [execa](https://npm.io/package/execa.md) ^6.1.0
- [semver](https://npm.io/package/semver.md) ^7.3.8
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [kolorist](https://npm.io/package/kolorist.md) ^1.6.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.6
- [@proload/core](https://npm.io/package/@proload/core.md) ^0.3.3

## Recent versions

- 1.2.1 (latest) — 2023-06-13
- 1.1.2 — 2022-10-14
- 1.1.1 — 2022-10-14
- 1.1.0 — 2022-10-14
- 1.0.4 — 2022-10-14
- 1.0.3 — 2022-10-09
- 1.0.2 — 2022-10-08

## README

## release-pkg

- release your package easily!

### config file

- install 
```bash
npm install release-pkg -D 
```

- config options

```javascript
module.exports = {
  releaseBranch: ['master', 'main'], // which git branch can be released
  releaseUser: ['pengbo-study'], // who can publish this pkg
  release: true, // auto publish or not
  scripts: {
    build: 'build', // if exist, run build command
    changelog: 'changelog', //if exist, run changelog command
  },
  tag: true // need git tag?
}
```

- package.json
```json
"script": {
  "build": "tsc", 
  "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
  "release": "release-pkg"
}
```

---
_Source: https://npm.io/package/release-pkg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._