https://github.com/hdorgeval/release-checker
Check your release before publishing
https://github.com/hdorgeval/release-checker
module npm package publish release-automation release-helper release-management
Last synced: about 1 month ago
JSON representation
Check your release before publishing
- Host: GitHub
- URL: https://github.com/hdorgeval/release-checker
- Owner: hdorgeval
- License: mit
- Created: 2018-12-21T21:26:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-13T22:22:15.000Z (about 6 years ago)
- Last Synced: 2025-03-19T21:06:42.310Z (about 1 month ago)
- Topics: module, npm, package, publish, release-automation, release-helper, release-management
- Language: TypeScript
- Size: 261 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Release Checker (alpha)
[](https://travis-ci.org/hdorgeval/release-checker)
[](https://ci.appveyor.com/project/hdorgeval/release-checker)
[](https://www.npmjs.com/package/release-checker)
There 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.
It checks the following:
- package.json file is valid
- build pass (unreleased)
- tests pass
- there is no sensitive data embedded in the package that will be sent to the registry
- there is no useless files (like tests files) embedded in the package that will be sent to the registry
- there are no vulnerable dependencies (unreleased)
- there are no uncommitted changes in the working tree
- there are no untracked files in the working tree
- current branch is `master` or `release`
- git tag matches version specified in the `package.json`
- all licenses declared in production dependencies are valid (unreleased)
## Warning
> 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`.
>
> - Run `npm help scripts` to get more details.
## Install
- local install
```sh
npm install --save-dev release-checker
```
Then add this script in the `scripts` section of the `package.json` file:
```json
"scripts": {
"release-checker": "release-checker"
},
```
- global install
```sh
npm install -g release-checker
```
## Basic usage
- local install
```sh
npm run release-checker
```
- global install
```sh
release-checker
```
- zero install
```sh
npx release-checker
```
## Command-line Options
When you specify no option, all checkers will run.
if you want to run only specific checkers, use the command-line options specific to these checkers.
### -b, --branch
Ensure that current branch is `master` or `release`.
### -c, --uncommited-files
Ensure there are no uncommited files in the working tree.
```sh
npx release-checker --uncommited-files
```
### --customize-sensitivedata
Customize the sensitive or useless data checker.
This will create, in the current directory, a `.sensitivedata` file that you can customize to fit your needs.
```sh
npx release-checker --customize-sensitivedata
```
### -h, --help
Show help.
```sh
npx release-checker --help
```
### -s, --sensitivedata
Ensure there is no sensitive or useless data in the npm package.
```sh
npx release-checker --sensitivedata
```
### --skip-\
Use this option when you want to run all checkers except specific ones.
For example this command will run all checkers except the test checker:
```sh
npx release-checker --skip-test
```
This other example will run all checkers except the test checker and the git-branch checker
```sh
npx release-checker --skip-test --skip-branch
```
The above command could be also rewritten to:
```sh
npx release-checker --skip-t --skip-b
```
### -T, --tag
Ensure that latest git tag matches package.json version
```sh
npx release-checker --tag
```
### -t, --test
Ensure that command `npm test` is successfull.
```sh
npx release-checker --test
```
### -u, --untracked-files
Ensure there are no untracked files in the working tree.
```sh
npx release-checker --untracked-files
```
## Sensitive or useless data Checker
This 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.
It will detect the following files:
> - Benchmark files
> - Configuration files
> - CI
> - eslint
> - GitHub
> - JetBrains
> - Visual Studio Code
> - Coverage files
> - Demo files
> - Dependency directories
> - Doc files
> - Example files
> - Log files
> - Private SSH key
> - Script files
> - Secret files
> - Source files
> - Temp files
> - Test files
> - Zip files
> - Output of 'npm pack' command
These files are defined inside the built-in [.sensitivedata](lib/checkers/sensitive-data-checker/.sensitivedata) file.
You may completely override this file by creating a `.sensitivedata` file in the root directory of your project so that this checker fits your needs:
- to create this file, just run the command:
```sh
npx release-checker --customize-sensitivedata
```
- if you create your own `.sensitivedata` file, and the `package.json` file has no `files` section, consider adding `.sensitivedata` to the `.npmignore` file.
## Authors
- [Ivan Nikulin](https://github.com/inikulin)
- [Henri d'Orgeval](https://github.com/hdorgeval)
This project is a port of all validations provided by [publish-please](https://github.com/inikulin/publish-please)