From dc3e4be03c200a2b74d8c3d4f96c8bfa6752915b Mon Sep 17 00:00:00 2001 From: Patrik Henningsson Date: Fri, 27 Jan 2023 19:52:23 +0100 Subject: [PATCH] Add NPM task and docs for creating a release --- .nvmrc | 2 +- .release-it.json | 12 ++++++++++++ README.md | 8 ++++++++ package.json | 5 ++++- 4 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 .release-it.json diff --git a/.nvmrc b/.nvmrc index fc9c00c1..3c032078 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -13.6.0 +18 diff --git a/.release-it.json b/.release-it.json new file mode 100644 index 00000000..9b25209f --- /dev/null +++ b/.release-it.json @@ -0,0 +1,12 @@ +{ + "pkgFiles": ["package.json", "package-lock.json"], + "git": { + "requireCleanWorkingDir": false + }, + "npm": { + "publish": false + }, + "hooks": { + "after:bump": "auto-changelog --hide-credit --package" + } +} diff --git a/README.md b/README.md index 4a88a3ad..9ff65fea 100644 --- a/README.md +++ b/README.md @@ -373,6 +373,14 @@ npm install npm test ``` +# Creating a release + +> Travis CI will automatically release the npm package to npmjs.com after a successful build. + +```sh +npm run release +``` + # FAQ ## Missing dependencies? diff --git a/package.json b/package.json index 68297c0e..a8fe274c 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,8 @@ "generate": "npm run generate:small && npm run generate:madge", "generate:small": "bin/cli.js --image /tmp/simple.svg test/cjs/circular/a.js", "generate:madge": "bin/cli.js --image /tmp/madge.svg bin lib", - "test:output": "./test/output.sh" + "test:output": "./test/output.sh", + "release": "npm test && release-it" }, "funding": { "type": "individual", @@ -68,9 +69,11 @@ }, "devDependencies": { "@aptoma/eslint-config": "^7.0.1", + "auto-changelog": "^2.4.0", "eslint": "^7.29.0", "mocha": "^9.0.1", "mz": "^2.7.0", + "release-it": "^15.6.0", "should": "^13.2.3" } }