Skip to content

Commit

Permalink
task: Renames package to @release-it-plugins/workspaces
Browse files Browse the repository at this point in the history
  • Loading branch information
scalvert committed Jul 20, 2022
1 parent b906110 commit 93d0400
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# release-it-yarn-workspaces
# @release-it-plugins/workspaces

This package is a [release-it](https://github.com/release-it/release-it) plugin
(using [`release-it`'s plugin
Expand All @@ -19,18 +19,18 @@ folder and calling `npm publish`).
Installation using your projects normal package manager, for example:

```sh
yarn add --dev --ignore-workspace-root-check release-it-yarn-workspaces
yarn add --dev --ignore-workspace-root-check @release-it-plugins/workspaces
```

Once installed, configure `release-it` to use the plugin.
Once installed, configure `release-it` to use the plugin.

For example, configuring via `package.json` would look like this:

```json
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": true
"@release-it-plugins/workspaces": true
}
}
}
Expand All @@ -46,7 +46,7 @@ would add the following to your `release-it` config (again showing
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": true
"@release-it-plugins/workspaces": true
},
"npm": false
}
Expand All @@ -55,7 +55,7 @@ would add the following to your `release-it` config (again showing

## Configuration

For the most part `release-it-yarn-workspaces` "does the right thing", but
For the most part `@release-it-plugins/workspaces` "does the right thing", but
there are a few things that are configurable.

A quick summary (in TypeScript syntax) of the supported options (more details
Expand Down Expand Up @@ -115,7 +115,7 @@ interface ReleaseItYarnWorkSpacesConfiguration {

### skipChecks

By default, `release-it-yarn-workspaces` confirms that the `npm` registry is up
By default, `@release-it-plugins/workspaces` confirms that the `npm` registry is up
and running (via `npm ping`) and that you are authenticated properly (via `npm
whoami`). If you'd prefer to avoid these checks (e.g. your custom `npm`
registry does not support them) you can specify the `skipChecks` option:
Expand All @@ -124,7 +124,7 @@ registry does not support them) you can specify the `skipChecks` option:
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": {
"@release-it-plugins/workspaces": {
"skipChecks": true
}
}
Expand All @@ -134,7 +134,7 @@ registry does not support them) you can specify the `skipChecks` option:

### publish

`release-it-yarn-workspaces` publishes to the `npm` registry.
`@release-it-plugins/workspaces` publishes to the `npm` registry.
However, some repository configurations prefer to commit + tag then let CI
publish the actual packages to the registry. This is where the `publish` option
comes in:
Expand All @@ -143,7 +143,7 @@ comes in:
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": {
"@release-it-plugins/workspaces": {
"publish": false
}
}
Expand All @@ -157,7 +157,7 @@ published.

### distTag

`release-it-yarn-workspaces` uses the `latest` dist-tag when the
`@release-it-plugins/workspaces` uses the `latest` dist-tag when the
released version is a stable release and the prereleaseId when it is a
prerelease (e.g. `beta` for `1.0.0-beta.1`). This is a good default setup, but
there may be cases where you would like to specify a custom dist-tag to be
Expand All @@ -167,7 +167,7 @@ used.
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": {
"@release-it-plugins/workspaces": {
"distTag": "lts"
}
}
Expand All @@ -179,7 +179,7 @@ used.

The list of workspaces is gathered from the `package.json` in the current
working directory. This is the same location that `yarn install` uses, and it
is a great default for `release-it-yarn-workspaces`. In some circumstances, the
is a great default for `@release-it-plugins/workspaces`. In some circumstances, the
workspace settings that `yarn` should use differ from the actual locations that
are published. Most commonly this is due to a custom build script that emits
the compiled and ready to publish packages into a different location (e.g.
Expand All @@ -189,7 +189,7 @@ the compiled and ready to publish packages into a different location (e.g.
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": {
"@release-it-plugins/workspaces": {
"workspaces": ["dist/packages/*"]
}
}
Expand All @@ -198,7 +198,7 @@ the compiled and ready to publish packages into a different location (e.g.
```

This value replaces the value from `package.json`, and given the above
configuration `release-it-yarn-workspaces` would publish each package (that was
configuration `@release-it-plugins/workspaces` would publish each package (that was
not private) in `dist/packages` folder.

### additionalManifests
Expand All @@ -213,7 +213,7 @@ you may publish an alternate `docs.json` file in your published package.
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": {
"@release-it-plugins/workspaces": {
"additionalManifests": {
"versionUpdates": ["dist/docs.json"]
}
Expand All @@ -239,7 +239,7 @@ newly published versions.
{
"release-it": {
"plugins": {
"release-it-yarn-workspaces": {
"@release-it-plugins/workspaces": {
"additionalManifests": {
"dependencyUpdates": ["blueprints/*/package.json"]
}
Expand Down
4 changes: 2 additions & 2 deletions __tests__/plugin-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { createTempDir } from 'broccoli-test-helper';
import { factory, runTasks } from 'release-it/test/util/index.js';
import Plugin from '../index.js';

const namespace = 'release-it-yarn-workspaces';
const namespace = '@release-it-plugins/workspaces';

class TestPlugin extends Plugin {
constructor() {
Expand Down Expand Up @@ -116,7 +116,7 @@ function json(obj) {
return JSON.stringify(obj, null, 2);
}

describe('release-it-yarn-workspaces', () => {
describe('@release-it-plugins/workspaces', () => {
let ROOT = process.cwd();
let dir;

Expand Down
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export default class YarnWorkspacesPlugin extends Plugin {
publish: {
type: 'confirm',
message: (context) => {
const { distTag, packagesToPublish } = context['release-it-yarn-workspaces'];
const { distTag, packagesToPublish } = context['@release-it-plugins/workspaces'];

return this._formatPublishMessage(distTag, packagesToPublish);
},
Expand All @@ -143,7 +143,7 @@ export default class YarnWorkspacesPlugin extends Plugin {
'publish-as-public': {
type: 'confirm',
message(context) {
const { currentPackage } = context['release-it-yarn-workspaces'];
const { currentPackage } = context['@release-it-plugins/workspaces'];

return `Publishing ${currentPackage.name} failed because \`publishConfig.access\` is not set in its \`package.json\`.\n Would you like to publish ${currentPackage.name} as a public package?`;
},
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.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "release-it-yarn-workspaces",
"name": "@release-it-plugins/workspaces",
"version": "2.0.1",
"description": "release-it plugin for bumping and publishing yarn workspaces",
"keywords": [
Expand All @@ -8,7 +8,7 @@
"release-it-plugin",
"plugin"
],
"repository": "https://github.com/rwjblue/release-it-yarn-workspaces",
"repository": "https://github.com/rwjblue/@release-it-plugins/workspaces",
"license": "MIT",
"author": "Robert Jackson <me@rwjblue.com>",
"type": "module",
Expand Down

0 comments on commit 93d0400

Please sign in to comment.