# upm-release

> A cli tool to publish Unity packages

Latest version **1.0.0** (published 2019-12-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install upm-release
pnpm add upm-release
yarn add upm-release
bun add upm-release
```

Provides the command `upm-release`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-12-03 |
| First published | 2019-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.16 |
| Dependencies | 4 |
| Unpacked size | 11.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | mob-sakai |
| Maintainers | mob-sakai |
| Keywords | automation, package, release, semantic-release, semver, unity3d, upm |

## Links

- npm: https://www.npmjs.com/package/upm-release
- Repository: https://github.com/mob-sakai/upm-release
- Issues: https://github.com/mob-sakai/upm-release/issues
- npm.io page: https://npm.io/package/upm-release

## Dependencies (4)

- [git-snapshot](https://npm.io/package/git-snapshot.md) ^2.2.0
- [semantic-release](https://npm.io/package/semantic-release.md) ^16.0.0-beta.39
- [@semantic-release/git](https://npm.io/package/@semantic-release/git.md) ^7.1.0-beta.9
- [@semantic-release/changelog](https://npm.io/package/@semantic-release/changelog.md) ^3.0.6

## Recent versions

- 1.0.0 (latest) — 2019-12-03
- 1.0.0-beta.4 (beta) — 2019-11-19
- 1.0.0-beta.3 — 2019-11-19
- 1.0.0-beta.2 — 2019-11-19
- 1.0.0-beta.1 — 2019-11-19

## README

# upm-release

A cli tool to publish the Unity package with [semantic-release](https://github.com/semantic-release/semantic-release).

[![npm](https://img.shields.io/npm/v/upm-release)](https://www.npmjs.com/package/upm-release)
[![npm (beta)](https://img.shields.io/npm/v/upm-release/beta)](https://www.npmjs.com/package/upm-release/v/beta)
[![GitHub Actions](https://github.com/mob-sakai/upm-release/workflows/release/badge.svg)](https://github.com/mob-sakai/upm-release/actions)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## Features

- Provides an informative [git](https://github.com/semantic-release/git) commit message for the release commit that does not trigger continuous integration and conforms to the [conventional commits specification](https://www.conventionalcommits.org/) (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
- Commits the version change in `package.json`.
- Creates or updates a [changelog](https://github.com/semantic-release/changelog) file based on commit messages.
- Publishes the package contents to another branch.
- (Option) Publishes the created tarball to any [npm](https://github.com/semantic-release/npm) registry.

## Install

```bash
$ npm install -g upm-release
```

## Usage

```bash
$ cd path/to/package/root
$ upm-release
```

Or

```bash
$ upm-release --pkg-root path/to/package/root
```

For details:

```
Usage: upm-release [--pkg-root=<path>] [--npm-publish] [--dry-run] [--debug]

Options:
  --help, -h     Show help                                         [boolean]
  --version, -v  Show version                                      [boolean]
  --pkg-root     The root path of the unity package.                [string]
  --npm-publish  Publish to npm registory.                         [boolean]
  --dry-run      Skip publishing                                   [boolean]
  --debug        Output debugging information                      [boolean]
```

## Environment Variables

| Variable    | Description                                                                                                                  |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `GH_TOKEN`  | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).    |
| `GL_TOKEN`  | A GitLab [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html).                       |
| `BB_TOKEN`  | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html). |
| `NPM_TOKEN` | A [npm token](https://docs.npmjs.com/creating-and-viewing-authentication-tokens).                                            |

**NOTE:** `NPM_TOKEN` supports only the `auth-only` [level of npm two-factor authentication](https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication).

---
_Source: https://npm.io/package/upm-release · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
