# updoot

> A githook designed to remind you to update your changelog and move released changes into a release entries.

Latest version **0.4.0** (published 2021-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install updoot
pnpm add updoot
yarn add updoot
bun add updoot
```

Provides the command `updoot`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2021-04-14 |
| First published | 2021-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 35.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Matt McElwee |
| Maintainers | renddslow |
| Keywords | git, githook, changelog, keep-a-changelog, reminder, cli |

## Links

- npm: https://www.npmjs.com/package/updoot
- Repository: https://github.com/Renddslow/verify-changelog
- Homepage: https://github.com/Renddslow/verify-changelog#readme
- Issues: https://github.com/Renddslow/verify-changelog/issues
- npm.io page: https://npm.io/package/updoot

## Dependencies (6)

- [sade](https://npm.io/package/sade.md) ^1.7.3
- [kleur](https://npm.io/package/kleur.md) ^4.0.2
- [globby](https://npm.io/package/globby.md) ^11.0.1
- [dot-prop](https://npm.io/package/dot-prop.md) ^5.2.0
- [multimatch](https://npm.io/package/multimatch.md) ^4.0.0
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^7.0.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.4.0 (latest) — 2021-04-14
- 0.3.0 — 2021-04-13
- 0.2.0 — 2021-04-13

## README

# updoot

> A githook designed to remind you to update your changelog.

## Install

```
$ yarn add updoot
```

## Usage

This was designed to work in conjunction with husky and lint-staged. However, you can use it solo by passing a list of files to it.

```
  Description
    Checks to see if a Changelog is present in the list of changed files and alerts if one is not present.

  Usage
    $ updoot remind [options]

  Options
    -w, --workspace      Whether or not updoot should look for changelogs in yarn workspaces  (default false)
    --warn               Print to stdout without an exit(1) when changelogs are missing.  (default false)
    -i, --ignore-pkgs    When in a monorepo context, a comma-delimited list of packages to ignore
    --pattern            A case-insensitive wildcard pattern describing the filename of changelogs  (default changelog*)
    -h, --help           Displays this message
```

## Options

Since this is intended to be used with git and lint-staged, you may also provide an ENV argument to skip updoot when needed.

```
$ SKIP_UPDOOT=true git commit -m "Added a comma to a comment"
```

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