# npm-github-config

> Semantic-release shareable config for NPM with Github

Latest version **2.0.1** (published 2019-10-16) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install npm-github-config
pnpm add npm-github-config
yarn add npm-github-config
bun add npm-github-config
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2019-10-16 |
| First published | 2018-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3 |
| Dependencies | 0 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Leonardo Gatica |
| Maintainers | lgatica |
| Keywords | github, npm, changelog, release, semantic-release, semantic-release-config, version |

## Links

- npm: https://www.npmjs.com/package/npm-github-config
- Repository: https://github.com/lgaticaq/npm-github-config
- Homepage: https://github.com/lgaticaq/npm-github-config#readme
- Issues: https://github.com/lgaticaq/npm-github-config/issues
- npm.io page: https://npm.io/package/npm-github-config

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2019-10-16
- 2.0.0 — 2018-09-21
- 1.0.0 — 2018-09-18

## README

# npm-github-config

[![npm version](https://img.shields.io/npm/v/npm-github-config.svg)](https://www.npmjs.com/package/npm-github-config)
[![npm downloads](https://img.shields.io/npm/dm/npm-github-config.svg)](https://www.npmjs.com/package/npm-github-config)
[![Build Status](https://img.shields.io/travis/lgaticaq/npm-github-config.svg)](https://travis-ci.org/lgaticaq/npm-github-config)
[![Maintainability](https://api.codeclimate.com/v1/badges/707123360dd51ea1ffaf/maintainability)](https://codeclimate.com/github/lgaticaq/npm-github-config/maintainability)
[![devDependency Status](https://img.shields.io/david/dev/lgaticaq/npm-github-config.svg)](https://david-dm.org/lgaticaq/npm-github-config#info=devDependencies)

> [Semantic-release](https://github.com/semantic-release/semantic-release) shareable config for [NPM](https://www.npmjs.com/) with [GitHub](https://github.com/).

## Usage

### Local installation

```bash
npm i -D semantic-release npm-github-config @semantic-release/{changelog,git}
```

In `package.json`:

```json
{
  "release": {
    "extends": "npm-github-config"  
  }
}
```

### Global installation

```bash
$ npm i -g semantic-release npm-github-config @semantic-release/{changelog,git}
$ semantic-release -e npm-github-config
```

## Configuration

### GitHub authentication

The GitHub authentication configuration is **required** and can be set via [environment variables](#environment-variables).

See [GitHub authentication](https://github.com/semantic-release/gitlab#gitlab-authentication).

### Npm registry authentication

The npm authentication configuration is **required** and can be set via [environment variables](#environment-variables).

See [Npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication)

### Environment variables

| Variable                     | Description                                                                                   |
|------------------------------|----------------------------------------------------------------------                         |
| `GH_TOKEN` or `GITHUB_TOKEN` | **Required.** The token used to authenticate with GitLab repository.                          |
| `NPM_TOKEN`                  | **Required.** Npm token created via [npm token create](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) |

### Additional options

This shareable config uses the [`@semantic-release/changelog`](https://github.com/semantic-release/changelog), [`@semantic-release/git`](https://github.com/semantic-release/git), [`@semantic-release/github`](https://github.com/semantic-release/github) and [`@semantic-release/npm`](https://github.com/semantic-release/npm) plugins. See the documentation of each plugins for additional options.
Options can be set in the Semantic-release configuration.

For example to set a custom GitHub URL:

```json
{
  "release": {
    "extends": "npm-github-config",
    "githubUrl": "https://custom.github.com"
  }
}
```

## License

[MIT](https://tldrlegal.com/license/mit-license)

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