{"id":15434181,"url":"https://github.com/hdorgeval/release-checker","last_synced_at":"2026-05-04T02:34:21.453Z","repository":{"id":57352794,"uuid":"162759104","full_name":"hdorgeval/release-checker","owner":"hdorgeval","description":"Check your release before publishing","archived":false,"fork":false,"pushed_at":"2019-02-13T22:22:15.000Z","size":267,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-19T21:06:42.310Z","etag":null,"topics":["module","npm","package","publish","release-automation","release-helper","release-management"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hdorgeval.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-21T21:26:54.000Z","updated_at":"2022-07-06T08:57:35.000Z","dependencies_parsed_at":"2022-09-05T11:40:50.735Z","dependency_job_id":null,"html_url":"https://github.com/hdorgeval/release-checker","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Frelease-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Frelease-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Frelease-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdorgeval%2Frelease-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hdorgeval","download_url":"https://codeload.github.com/hdorgeval/release-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245978277,"owners_count":20703678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["module","npm","package","publish","release-automation","release-helper","release-management"],"created_at":"2024-10-01T18:37:44.860Z","updated_at":"2026-05-04T02:34:16.421Z","avatar_url":"https://github.com/hdorgeval.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release Checker (alpha)\n\n[![Build Status](https://travis-ci.org/hdorgeval/release-checker.svg?branch=master)](https://travis-ci.org/hdorgeval/release-checker)\n[![Build status](https://ci.appveyor.com/api/projects/status/ltcrrup7unm78tir?svg=true)](https://ci.appveyor.com/project/hdorgeval/release-checker)\n[![npm version](https://img.shields.io/npm/v/release-checker.svg)](https://www.npmjs.com/package/release-checker)\n\nThere are numerous ways to \"shoot yourself in the foot\" using `npm publish`. The purpose of this module is to validate that your project is ready to be published in a safe way.\n\nIt checks the following:\n\n- package.json file is valid\n- build pass (unreleased)\n- tests pass\n- there is no sensitive data embedded in the package that will be sent to the registry\n- there is no useless files (like tests files) embedded in the package that will be sent to the registry\n- there are no vulnerable dependencies (unreleased)\n- there are no uncommitted changes in the working tree\n- there are no untracked files in the working tree\n- current branch is `master` or `release`\n- git tag matches version specified in the `package.json`\n- all licenses declared in production dependencies are valid (unreleased)\n\n## Warning\n\n\u003e If you are running node 8 or above, and the `package.json` file has an already existing `prepublish` script, you should rename that script to `prepublishOnly` before using `release-checker`.\n\u003e\n\u003e - Run `npm help scripts` to get more details.\n\n## Install\n\n- local install\n\n  ```sh\n  npm install --save-dev release-checker\n  ```\n\n  Then add this script in the `scripts` section of the `package.json` file:\n\n  ```json\n  \"scripts\": {\n      \"release-checker\": \"release-checker\"\n    },\n  ```\n\n- global install\n\n  ```sh\n  npm install -g release-checker\n  ```\n\n## Basic usage\n\n- local install\n\n  ```sh\n  npm run release-checker\n  ```\n\n- global install\n\n  ```sh\n  release-checker\n  ```\n\n- zero install\n\n  ```sh\n  npx release-checker\n  ```\n\n## Command-line Options\n\nWhen you specify no option, all checkers will run.\n\nif you want to run only specific checkers, use the command-line options specific to these checkers.\n\n### -b, --branch\n\nEnsure that current branch is `master` or `release`.\n\n### -c, --uncommited-files\n\nEnsure there are no uncommited files in the working tree.\n\n```sh\nnpx release-checker --uncommited-files\n```\n\n### --customize-sensitivedata\n\nCustomize the sensitive or useless data checker.\nThis will create, in the current directory, a `.sensitivedata` file that you can customize to fit your needs.\n\n```sh\nnpx release-checker --customize-sensitivedata\n```\n\n### -h, --help\n\nShow help.\n\n```sh\nnpx release-checker --help\n```\n\n### -s, --sensitivedata\n\nEnsure there is no sensitive or useless data in the npm package.\n\n```sh\nnpx release-checker --sensitivedata\n```\n\n### --skip-\\\u003cchecker\\\u003e\n\nUse this option when you want to run all checkers except specific ones.\n\nFor example this command will run all checkers except the test checker:\n\n```sh\nnpx release-checker --skip-test\n```\n\nThis other example will run all checkers except the test checker and the git-branch checker\n\n```sh\nnpx release-checker --skip-test --skip-branch\n```\n\nThe above command could be also rewritten to:\n\n```sh\nnpx release-checker --skip-t --skip-b\n```\n\n### -T, --tag\n\nEnsure that latest git tag matches package.json version\n\n```sh\nnpx release-checker --tag\n```\n\n### -t, --test\n\nEnsure that command `npm test` is successfull.\n\n```sh\nnpx release-checker --test\n```\n\n### -u, --untracked-files\n\nEnsure there are no untracked files in the working tree.\n\n```sh\nnpx release-checker --untracked-files\n```\n\n## Sensitive or useless data Checker\n\nThis Checker checks there is no sensitive and no useless files inside the to-be-published package. This check performs only if npm version is 5.9.0 or above.\n\nIt will detect the following files:\n\n\u003e - Benchmark files\n\u003e - Configuration files\n\u003e   - CI\n\u003e   - eslint\n\u003e   - GitHub\n\u003e   - JetBrains\n\u003e   - Visual Studio Code\n\u003e - Coverage files\n\u003e - Demo files\n\u003e - Dependency directories\n\u003e - Doc files\n\u003e - Example files\n\u003e - Log files\n\u003e - Private SSH key\n\u003e - Script files\n\u003e - Secret files\n\u003e - Source files\n\u003e - Temp files\n\u003e - Test files\n\u003e - Zip files\n\u003e   - Output of 'npm pack' command\n\nThese files are defined inside the built-in [.sensitivedata](lib/checkers/sensitive-data-checker/.sensitivedata) file.\n\nYou may completely override this file by creating a `.sensitivedata` file in the root directory of your project so that this checker fits your needs:\n\n- to create this file, just run the command:\n\n```sh\nnpx release-checker --customize-sensitivedata\n```\n\n- if you create your own `.sensitivedata` file, and the `package.json` file has no `files` section, consider adding `.sensitivedata` to the `.npmignore` file.\n\n## Authors\n\n- [Ivan Nikulin](https://github.com/inikulin)\n- [Henri d'Orgeval](https://github.com/hdorgeval)\n\nThis project is a port of all validations provided by [publish-please](https://github.com/inikulin/publish-please)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhdorgeval%2Frelease-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhdorgeval%2Frelease-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhdorgeval%2Frelease-checker/lists"}