npm package: @public-js/cc-github-releaser
Description: Create GitHub releases from git metadata
Author: Public JS
Latest version: 2.0.3

# @public-js/cc-github-releaser

[![Build](https://github.com/public-js/cc-github-releaser/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/public-js/cc-github-releaser/actions/workflows/build.yml)
[![Version](https://img.shields.io/npm/v/@public-js/cc-github-releaser?style=flat)](https://www.npmjs.com/package/@public-js/cc-github-releaser)
[![Downloads](https://img.shields.io/npm/dw/@public-js/cc-github-releaser?style=flat)](https://www.npmjs.com/package/@public-js/cc-github-releaser)
[![Size](https://packagephobia.com/badge?p=@public-js/cc-github-releaser)](https://packagephobia.com/result?p=@public-js/cc-github-releaser)

[![CodeQL](https://github.com/public-js/cc-github-releaser/actions/workflows/codeql-analyze.yml/badge.svg?branch=main)](https://github.com/public-js/cc-github-releaser/actions/workflows/codeql-analyze.yml)
[![Codacy](https://app.codacy.com/project/badge/Grade/0f195238a77b4aed8905dfb982effbdf)](https://app.codacy.com/gh/public-js/cc-github-releaser/dashboard)
[![Codecov](https://codecov.io/gh/public-js/cc-github-releaser/branch/main/graph/badge.svg?token=BEOTLb2r0b)](https://codecov.io/gh/public-js/cc-github-releaser)
[![Code Climate](https://api.codeclimate.com/v1/badges/495500be06bbf1ed21e4/maintainability)](https://codeclimate.com/github/public-js/cc-github-releaser/maintainability)

Create GitHub releases from git metadata

---

## Installing

Add the package to your project by running:

```shell
npm i -D @public-js/cc-github-releaser
```

Create a [new token](https://github.com/settings/tokens/new) or use an existing one.
Make sure the token you're going to use has a `public_repo` scope (or `repo` for private repositories).

Assign you token to any of the following env variables: `GITHUB_TOKEN`, `GH_TOKEN`, `CONVENTIONAL_GITHUB_RELEASER_TOKEN`
or pass it with any of these parameters: `-t` or `--token`.

### Workflow setup

For you convenience, you might want to add the following to your root `package.json` file:

```
"scripts": {
  "github-release": "cc-github-releaser"
}
```

Execute it from you workflow like this:

```yaml
run: npm run github-release
```

### Recommended workflow

- Commit your changes
- Make sure you build/tests pass
- Bump version with any tool e.g. `standard-version`
  or do it manually then commit the change
- Create & push a version tag e.g. `1.2.3`
- Execute `cc-github-releaser` to create a release

If you want a more fancy release process, check out [this workflow](.github/workflows/release.yml).

## Package size

Although Package Phobia reports this package to be pretty heavy, keep in mind that:

- This package should not be bundled with your distribution
- You probably already have at least half of its dependencies' installed
- This package allows a lot of flexibility in dependencies' versions

## Resources

- [Changelog](CHANGELOG.md)
- [Contributing Guidelines](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)

## License

MIT, [full license text](LICENSE).
Read more about it on [TLDRLegal](https://www.tldrlegal.com/license/mit-license).