open-index/open-npm huggingface dataset:
npm package: @octorelease/core
Description: Octorelease core package containing the CLI and APIs for plugins.
Author: t1m0thyj
Latest version: 0.1.8

# Octorelease CLI

[Octorelease](https://github.com/octorelease/octorelease) core package containing the CLI and APIs for plugins.

[![Build Status](https://github.com/octorelease/octorelease/workflows/Test/badge.svg)](https://github.com/octorelease/octorelease/actions?query=workflow%3ATest+branch%3Amaster)
[![npm latest version](https://img.shields.io/npm/v/@octorelease/core/latest.svg)](https://www.npmjs.com/package/@octorelease/core)
<!-- [![npm next version](https://img.shields.io/npm/v/@octorelease/core/next.svg)](https://www.npmjs.com/package/@octorelease/core) -->

| Step | Description |
|------|-------------|
| `init` | Gather release notes from the package changelog(s). |
| `version` | Update the version numbers in the package changelog(s). |
| `publish` | Update the version numbers in the package changelog(s). |
| `success` | Update the version numbers in the package changelog(s). |
| `fail` | Update the version numbers in the package changelog(s). |

## Install

```bash
$ npm install @octorelease/core -D
```

## Usage

TODO

## Configuration

TODO
npm package: @octorelease/lerna
Description: Octorelease plugin to perform actions related to NPM for Lerna monorepo.
Author: t1m0thyj
Latest version: 0.1.4

# Lerna plugin

[Octorelease](https://github.com/octorelease/octorelease) plugin to perform actions related to NPM for Lerna monorepo.

[![Build Status](https://github.com/octorelease/lerna/workflows/Test/badge.svg)](https://github.com/octorelease/lerna/actions?query=workflow%3ATest+branch%3Amaster)
[![npm latest version](https://img.shields.io/npm/v/@octorelease/lerna/latest.svg)](https://www.npmjs.com/package/@octorelease/lerna)
<!-- [![npm next version](https://img.shields.io/npm/v/@octorelease/lerna/next.svg)](https://www.npmjs.com/package/@octorelease/lerna) -->

| Step | Description |
|------|-------------|
| `init` | Load version numbers from lerna.json and login to NPM registry. |
| `version` | Bump changed package versions with lerna CLI. |
| `publish` | Publish the new package versions to NPM registry. |
| `success` | Verify that new package versions can be installed successfully. |

## Install

```bash
$ npm install @octorelease/lerna -D
```

## Usage

The plugin can be configured in the [Octorelease configuration file](https://github.com/octorelease/octorelease/blob/master/docs/usage.md#configuration):

```json
{
  "plugins": [
    "@octorelease/lerna"
  ]
}
```

## Configuration

See the documentation for [@octorelease/npm](https://github.com/octorelease/octorelease/tree/master/packages/npm#configuration).

<!-- TODO Mention npm@7 or newer requirement for workspaces -->
npm package: @octorelease/npm
Description: Octorelease plugin to perform actions related to NPM.
Author: t1m0thyj
Latest version: 0.1.5

# NPM plugin

[Octorelease](https://github.com/octorelease/octorelease) plugin to perform actions related to NPM.

[![Build Status](https://github.com/octorelease/octorelease/workflows/Test/badge.svg)](https://github.com/octorelease/octorelease/actions?query=workflow%3ATest+branch%3Amaster)
[![npm latest version](https://img.shields.io/npm/v/@octorelease/npm/latest.svg)](https://www.npmjs.com/package/@octorelease/npm)
<!-- [![npm next version](https://img.shields.io/npm/v/@octorelease/npm/next.svg)](https://www.npmjs.com/package/@octorelease/npm) -->

| Step | Description |
|------|-------------|
| `init` | Load version numbers from package.json and login to NPM registry. |
| `version` | Bump the package version with npm CLI. |
| `publish` | Publish the new package version to NPM registry. |
| `success` | Verify that new package version can be installed successfully. |

## Install

```bash
$ npm install @octorelease/npm -D
```

## Usage

The plugin can be configured in the [Octorelease configuration file](https://github.com/octorelease/octorelease/blob/master/docs/usage.md#configuration):

```json
{
  "plugins": [
    "@octorelease/npm"
  ]
}
```

## Configuration

### Environment variables

| Variable | Description |
| -------- | ----------- |
| `NPM_TOKEN` | Access token of the NPM publisher. |
| `NPM_USERNAME` | User name of the NPM publisher. |
| `NPM_PASSWORD` | Password of the NPM publisher. |
| `NPM_EMAIL` | Email address of the NPM publisher. |

Use either `NPM_TOKEN` for token authentication or `NPM_USERNAME`, `NPM_PASSWORD`, and `NPM_EMAIL` for legacy authentication.

### Options

| Options | Description | Default |
| ------- | ----------- | ------- |
| `aliasTags` | Key-value pairs of package tags that should be mirrored (see example below). | `{}` |
| `npmPublish` | Specify false to skip publishing to the NPM registry. | `true` |
| `pruneShrinkwrap` | Specify true to prune dev and extraneous dependencies from npm-shrinkwrap.json. | `false` |
| `smokeTest` | Specify true to test installing the package from the NPM registry after it is published. | `false` |
| `tarballDir` | Path to directory where package tarball (TGZ) should be generated, or `false` to skip creating a tarball. | `false` |

### Examples

To mirror the `@latest` tag to `@lts`:

```json
{
  "plugins": [
    ["@octorelease/npm", {
      "aliasTags": {
        "latest": "lts"
      }
    }]
  ]
}
```

---
To skip publishing to the NPM registry and release the package tarball with another plugin like [@octorelease/github](https://github.com/octorelease/octorelease/tree/master/packages/github):

```json
{
  "plugins": [
    ["@octorelease/npm", {
      "npmPublish": false,
      "tarballDir": "dist"
    }],
    ["@octorelease/github", {
      "assets": "dist/*.tgz"
    }]
  ]
}
```
npm package: @octorelease/prune-shrinkwrap
Description: Octorelease plugin to prune npm shrinkwrap files.
Author: t1m0thyj
Latest version: 0.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Prune Shrinkwrap plugin

[Octorelease](https://github.com/octorelease/octorelease) plugin to prune npm shrinkwrap files.

[![Build Status](https://github.com/octorelease/prune-shrinkwrap/workflows/Test/badge.svg)](https://github.com/octorelease/octorelease/actions?query=workflow%3ATest+branch%3Amaster)
[![npm latest version](https://img.shields.io/npm/v/@octorelease/prune-shrinkwrap/latest.svg)](https://www.npmjs.com/package/@octorelease/prune-shrinkwrap)
<!-- [![npm next version](https://img.shields.io/npm/v/@octorelease/prune-shrinkwrap/next.svg)](https://www.npmjs.com/package/@octorelease/prune-shrinkwrap) -->

| Step | Description |
|------|-------------|
| `init` | Validate plugin configuration. |
| `version` | Prune unwanted dependencies from npm shrinkwrap file. |

## Install

```bash
$ npm install @octorelease/prune-shrinkwrap -D
```

## Usage

The plugin can be configured in the [Octorelease configuration file](https://github.com/octorelease/octorelease/blob/master/docs/usage.md#configuration):

```json
{
  "plugins": [
    "@octorelease/prune-shrinkwrap"
  ]
}
```

## Configuration

### Options

| Options | Description | Default |
| ------- | ----------- | ------- |
| `filters` | List of [package dependency flags](https://github.com/npm/arborist#package-dependency-flags) to prune from shrinkwrap. | `["dev", "extraneous"]` |
| `packages` | Folder patterns of packages in monorepo that should have shrinkwrap pruned. | `false` |

### Examples

To prune shrinkwrap for only the CLI package in a monorepo:

```json
{
  "plugins": [
    ["@octorelease/prune-shrinkwrap", {
      "packages": ["packages/cli"]
    }]
  ]
}
```