# @0x303133/changelog

> PR-based changelog generator with monorepo support

Latest version **1.0.0** (published 2023-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @0x303133/changelog
pnpm add @0x303133/changelog
yarn add @0x303133/changelog
bun add @0x303133/changelog
```

Provides the command `changelog`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-07-05 |
| First published | 2023-07-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 43 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 0x303133 |
| Maintainers | 0x303133 |
| Keywords | changelog |

## Links

- npm: https://www.npmjs.com/package/@0x303133/changelog
- Repository: https://github.com/0x303133/changelog
- Homepage: https://github.com/0x303133/changelog#readme
- Issues: https://github.com/0x303133/changelog/issues
- npm.io page: https://npm.io/package/@0x303133/changelog

## Dependencies (6)

- [axios](https://npm.io/package/axios.md) ^1.4.0
- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [cli-highlight](https://npm.io/package/cli-highlight.md) ^2.1.11
- [@esm2cjs/execa](https://npm.io/package/@esm2cjs/execa.md) ^6.1.1-cjs.1
- [hosted-git-info](https://npm.io/package/hosted-git-info.md) ^6.1.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-07-05

## README

��

# Changelog

## Table of content:
- [Important](#important)
- [Usage](#usage)
- [Monorepo](#monorepo-support)
- [Configuration](#configuration)

### Important

`changelog` use GitHub api. You need provide GitHub Personal Access Token in `.changelogc`. You'll need a [personal access token](https://github.com/settings/tokens) for the GitHub API with the `repo` scope for private repositories or just `public_repo` scope for public repositories.

You alse need to provide repository link to `package.json`
```json
"repository": {  
	"type": "git",  
	"url": "git+https://github.com/0x303133/changelog.git"  
}
```

### Usage
```bash
npx changelog
```
------------------------------------------------------------------------------  
```md  
## Changelog.
#### It was automatically generated by [0x303133/changelog](https://github.com/0x303133/changelog).

## v1.0.0

#### :rocket: Enhancement
  * [#5](https://github.com/0x303133/changelog/pull/5) feat: Create CLI ([@0x303133](https://github.com/0x303133))

#### Other
  * [#3](https://github.com/0x303133/changelog/pull/3) chore(deps-dev): Bump @typescript-eslint/parser from 5.60.1 to 5.61.0 ([@dependabot[bot]](https://github.com/apps/dependabot))
  * [#4](https://github.com/0x303133/changelog/pull/4) chore(deps-dev): Bump @typescript-eslint/eslint-plugin from 5.60.1 to 5.61.0 ([@dependabot[bot]](https://github.com/apps/dependabot))
  * [#1](https://github.com/0x303133/changelog/pull/1) chore: Create base configuration for repo ([@0x303133](https://github.com/0x303133))

#### Committers: 1
- [@0x303133](https://github.com/0x303133)
#### Full changelog: [`v0.0.0...v1.0.0`](https://github.com/0x303133/changelog/compare/v0.0.0...v1.0.0)
```  
------------------------------------------------------------------------------

By default  `0x303133/changelog`  will show all pull requests that have been merged since the latest tagged commit in the repository. That is however only true for pull requests with certain labels applied. The labels that are supported by default are:

-   `breaking`  (=إ� Breaking Change)
-   `enhancement`  (=؀�  Enhancement)
-   `bug`  (=��  Bug Fix)
-   `documentation`  (=��� Documentation)
-   `internal`  (<��� Internal)

You can also use the  `--from`  and  `--to`  options to view a different range of pull requests:

```bash 
npx changelog --from=v1.0.0 --to=v2.0.0
```

### Monorepo support

If you have a packages folder and your projects in subfolders of that folder  `changelog`  will detect it and include the package names in the changelog for the relevant changes.

### Configuration

You can use the cli settings to simplify your life and avoid mistakes.
| title               | description                                                          |
|---------------------|----------------------------------------------------------------------|
| from                | A git tag that determines the lower bound of the range of commits    |
| to                  | A git tag that determines the upper bound of the range of commits    |
| next-version        | The name of the next version                                         |
| contributors-marker | Contributors marker that will be used in render. Default: -          |
| commits-marker      | Commits marker that will be used in render. Default: *               |
| filename            | Output filename, without extension                                   |

Also, you can create own labels like in your GitHub and add ignore contributors that won't be shown in contributors list.

### License

`changelog`  is released under the  [MIT License](https://github.com/0x303133/changelog/blob/main/LICENSE).

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