# @dkshs/changelog-github

> A changelog entry generator for changeset on GitHub with links to commits, PRs and optionally users.

Latest version **2.0.0** (published 2025-03-31) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @dkshs/changelog-github
pnpm add @dkshs/changelog-github
yarn add @dkshs/changelog-github
bun add @dkshs/changelog-github
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2025-03-31 |
| First published | 2023-11-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 15 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nicolas Contiero |
| Maintainers | dkshs, ncontiero |

## Links

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

## Dependencies (2)

- [dotenv](https://npm.io/package/dotenv.md) ^16.4.7
- [@changesets/get-github-info](https://npm.io/package/@changesets/get-github-info.md) ^0.6.0

## Recent versions

- 2.0.0 (latest) — 2025-03-31
- 1.0.6 — 2024-04-25
- 1.0.5 — 2024-03-08
- 1.0.4 — 2023-12-18
- 1.0.4-test — 2023-12-18
- 1.0.3 — 2023-11-28
- 1.0.2 — 2023-11-06
- 1.0.1 — 2023-11-04
- 1.0.0 — 2023-11-04
- 0.0.6 — 2023-11-04
- 0.0.5 — 2023-11-04
- 0.0.4 — 2023-11-04
- 0.0.3 — 2023-11-04
- 0.0.2 — 2023-11-04
- 0.0.1 — 2023-11-04

## README

<div align="center">

# `@dkshs/changelog-github`

A changelog entry generator for [changeset](https://github.com/changesets/changesets) on GitHub with links to commits, PRs, and optionally users.

[![license mit](https://img.shields.io/badge/licence-MIT-7c3aed)](https://github.com/ncontiero/changelog-github/blob/master/LICENSE)
[![NPM version][npm-image]][npm-url]

</div>

[npm-url]: https://www.npmjs.com/package/@dkshs/changelog-github
[npm-image]: https://img.shields.io/npm/v/@dkshs/changelog-github?color=7c3aed&logoColor=7c3aed

## Getting Started

First Install the package:

```bash
npm i --save-dev @dkshs/changelog-github
```

And use it on `.changeset/config.json`:

```json
{
  // ...
  "changelog": [
    "@dkshs/changelog-github", { "repo": "<org>/<repo>" }
  ]
  // ...
}
```

There is also an optional option, which is `exclude`, an object and can have the `user`,`pr` and `commit` keys and their values being boolean.

```json
{
  // ...
  "changelog": [
    "@dkshs/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": { "user": true }
    }
  ]
  // ...
}
```

This option does not add the comment: "Thanks <@user>!".

And you can use to remove the pull releases:

```json
{
  // ...
  "changelog": [
    "@dkshs/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": { "pr": true }
    }
  ]
  // ...
}
```

And to remove the commits:

```json
{
  // ...
  "changelog": [
    "@dkshs/changelog-github",
    {
      "repo": "<org>/<repo>",
      "exclude": { "commit": true }
    }
  ]
  // ...
}
```

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