Skip to content

Commit

Permalink
Merge pull request #224 from release-it-plugins/rename
Browse files Browse the repository at this point in the history
  • Loading branch information
scalvert committed Jul 20, 2022
2 parents 52d08f6 + 9ea89d6 commit 28661a5
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 19 deletions.
20 changes: 10 additions & 10 deletions 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
Expand All @@ -12,20 +12,20 @@ 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`:

```json
{
"release-it": {
"plugins": {
"release-it-lerna-changelog": {}
"@release-it-plugins/lerna-changelog": {}
}
}
}
Expand All @@ -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.

Expand All @@ -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
}
Expand All @@ -62,15 +62,15 @@ 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`

`infile` represents the file to prepend the generated changelog into.

### `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.

Expand Down
6 changes: 3 additions & 3 deletions __tests__/plugin-test.js
Expand Up @@ -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;
Expand Down Expand Up @@ -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();

Expand Down Expand Up @@ -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();
Expand Down
2 changes: 1 addition & 1 deletion index.js
Expand Up @@ -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);

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions 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": [
Expand All @@ -10,7 +10,7 @@
"changelog",
"lerna"
],
"repository": "https://github.com/rwjblue/release-it-lerna-changelog",
"repository": "https://github.com/@release-it-plugins/lerna-changelog",
"license": "MIT",
"author": "Robert Jackson <me@rwjblue.com>",
"main": "index.js",
Expand Down Expand Up @@ -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": {
Expand Down

0 comments on commit 28661a5

Please sign in to comment.