From bda2520381e4d5cfa914aa203c750962fa45f8fa Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 20 Jul 2022 11:32:20 -0700 Subject: [PATCH 1/3] task: Renames package to @release-it-plugins/lerna-changelog --- README.md | 20 ++++++++++---------- __tests__/plugin-test.js | 6 +++--- index.js | 2 +- package-lock.json | 4 ++-- package.json | 4 ++-- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index efa39af..f99065d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# release-it-lerna-changelog +# @release-it-plugins/lerna-changelog This package is a [release-it](https://github.com/release-it/release-it) plugin (using [`release-it`'s plugin @@ -12,12 +12,12 @@ Installation using your projects normal package manager, for example: ``` # npm -npm install --save-dev release-it-lerna-changelog +npm install --save-dev @release-it-plugins/lerna-changelog -# yarn add --dev release-it-lerna-changelog +# yarn add --dev @release-it-plugins/lerna-changelog ``` -Once installed, configure `release-it` to use the plugin. +Once installed, configure `release-it` to use the plugin. Either via `package.json`: @@ -25,7 +25,7 @@ Either via `package.json`: { "release-it": { "plugins": { - "release-it-lerna-changelog": {} + "@release-it-plugins/lerna-changelog": {} } } } @@ -36,14 +36,14 @@ Or via `.release-it.json`: ```json { "plugins": { - "release-it-lerna-changelog": {} + "@release-it-plugins/lerna-changelog": {} } } ``` ## Configuration -`release-it-lerna-changelog` supports one configuration option, `infile`. When +`@release-it-plugins/lerna-changelog` supports one configuration option, `infile`. When specified, this option represents the file name to prepend changelog information to during a release. @@ -53,7 +53,7 @@ For example, given the following configuration (in `package.json`): { "release-it": { "plugins": { - "release-it-lerna-changelog": { + "@release-it-plugins/lerna-changelog": { "infile": "CHANGELOG.md", "launchEditor": true } @@ -62,7 +62,7 @@ For example, given the following configuration (in `package.json`): } ``` -The two options that `release-it-lerna-changelog` is aware of are: +The two options that `@release-it-plugins/lerna-changelog` is aware of are: ### `infile` @@ -70,7 +70,7 @@ The two options that `release-it-lerna-changelog` is aware of are: ### `launchEditor` -When specified, `release-it-lerna-changelog` will generate the changelog +When specified, `@release-it-plugins/lerna-changelog` will generate the changelog then launch the configured editor with a temporary file. This allows the person doing the release to customize the changelog before continuing. diff --git a/__tests__/plugin-test.js b/__tests__/plugin-test.js index 12b67db..928b283 100644 --- a/__tests__/plugin-test.js +++ b/__tests__/plugin-test.js @@ -13,7 +13,7 @@ tmp.setGracefulCleanup(); const require = createRequire(import.meta.url); const LERNA_PATH = require.resolve('lerna-changelog/bin/cli'); -const namespace = 'release-it-lerna-changelog'; +const namespace = '@release-it-plugins/lerna-changelog'; function resetPATH() { process.env.PATH = PATH; @@ -87,7 +87,7 @@ function buildPlugin(config = {}, _Plugin = TestPlugin) { return plugin; } -describe('release-it-lerna-changelog', () => { +describe('@release-it-plugins/lerna-changelog', () => { test('it invokes lerna-changelog', async () => { let plugin = buildPlugin(); @@ -300,7 +300,7 @@ describe('release-it-lerna-changelog', () => { ]); expect(error.message).toEqual( - `release-it-lerna-changelog configured to launch your editor but no editor was found (tried $EDITOR and searching $PATH for \`editor\`).` + `@release-it-plugins/lerna-changelog configured to launch your editor but no editor was found (tried $EDITOR and searching $PATH for \`editor\`).` ); } finally { resetEDITOR(); diff --git a/index.js b/index.js index 3282215..4a23000 100644 --- a/index.js +++ b/index.js @@ -108,7 +108,7 @@ export default class LernaChangelogGeneratorPlugin extends Plugin { if (!EDITOR) { let error = new Error( - `release-it-lerna-changelog configured to launch your editor but no editor was found (tried $EDITOR and searching $PATH for \`editor\`).` + `@release-it-plugins/lerna-changelog configured to launch your editor but no editor was found (tried $EDITOR and searching $PATH for \`editor\`).` ); this.log.error(error.message); diff --git a/package-lock.json b/package-lock.json index 6f7b0bf..f60e37d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "release-it-lerna-changelog", + "name": "@release-it-plugins/lerna-changelog", "version": "5.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "release-it-lerna-changelog", + "name": "@release-it-plugins/lerna-changelog", "version": "5.0.0", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 854c56b..c96147f 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "release-it-lerna-changelog", + "name": "@release-it-plugins/lerna-changelog", "version": "5.0.0", "description": "release-it plugin for lerna-changelog ", "keywords": [ @@ -10,7 +10,7 @@ "changelog", "lerna" ], - "repository": "https://github.com/rwjblue/release-it-lerna-changelog", + "repository": "https://github.com/rwjblue/@release-it-plugins/lerna-changelog", "license": "MIT", "author": "Robert Jackson ", "main": "index.js", From 4c54369f27c81de9e08cd95f43231493dce99542 Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 20 Jul 2022 11:32:42 -0700 Subject: [PATCH 2/3] Fixes repo path in package.json --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c96147f..b4def5a 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "changelog", "lerna" ], - "repository": "https://github.com/rwjblue/@release-it-plugins/lerna-changelog", + "repository": "https://github.com/@release-it-plugins/lerna-changelog", "license": "MIT", "author": "Robert Jackson ", "main": "index.js", From 9ea89d66b7755e0d9a17c6dd413f18f038084543 Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 20 Jul 2022 12:19:27 -0700 Subject: [PATCH 3/3] Adding access public to package.json --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index b4def5a..b584aaa 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,8 @@ "node": "^14.13.1 || >= 16" }, "publishConfig": { - "registry": "https://registry.npmjs.org/" + "registry": "https://registry.npmjs.org/", + "access": "public" }, "release-it": { "plugins": {