# simple-release

> An npm module for managing release of nested projects

Latest version **1.2.0** (published 2017-01-17) · MIT license · 0 weekly downloads

## Install

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

Provides the command `simple`.

## 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.2.0 |
| Published | 2017-01-17 |
| First published | 2016-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Karan Thakkar |
| Maintainers | geekykaran |
| Keywords | version, semver, release, publish, package, module, changelog, automation, author |

## Links

- npm: https://www.npmjs.com/package/simple-release
- Repository: https://github.com/karanjthakkar/simple-release
- Homepage: https://github.com/karanjthakkar/simple-release#readme
- Issues: https://github.com/karanjthakkar/simple-release/issues
- npm.io page: https://npm.io/package/simple-release

## Dependencies (10)

- [meow](https://npm.io/package/meow.md) ^3.7.0
- [async](https://npm.io/package/async.md) ^2.0.0
- [github](https://npm.io/package/github.md) ^8.1.0
- [semver](https://npm.io/package/semver.md) ^5.3.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.0
- [cli-list](https://npm.io/package/cli-list.md) ^0.2.0
- [inquirer](https://npm.io/package/inquirer.md) ^2.0.0
- [jsonfile](https://npm.io/package/jsonfile.md) ^2.3.1
- [is-github-url](https://npm.io/package/is-github-url.md) ^1.2.2
- [parse-github-url](https://npm.io/package/parse-github-url.md) ^1.0.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2017-01-17
- 1.1.0 — 2017-01-16
- 1.0.1 — 2016-07-19
- 0.0.1 — 2016-07-15

## README

# :rocket: simple-release

**An npm module for managing release of nested projects**

[![Dependency Status](https://david-dm.org/karanjthakkar/simple-release.svg)](https://david-dm.org/karanjthakkar/simple-release)

# Why

This was built out of my personal frustration in manually writing changelogs for our project releases. What we have is multiple repositories for different projects and a base repository where all the code is combined before release. Instead of maintaing changelog's for tens of different projects in their own github releases, what this does is combine the latest commits of the base project and all dependent projects and combine them into one changelog, which is used to maintained in the release of the base repository.


# Example

Lets say you have a `Project Base`. There is `SubProject 1` and `SubProject 2` which are included within `Project Base` before release. What `simple-release` aims to do is generate a changelog for each: `Project Base`, `SubProject 1` and `SubProject 2`. This is then used to create a tagged release in github.

# How it works / Setup

Install this module using: `npm install -g simple-release`

## Step 1: 

This releases needs access to your github account for creating releases and writing to your project repository. So you will need to create and add your github token to the environment variable `GITHUB_TOKEN`. For more info, check [this article](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)

## Step 2:

Go to your base project and type: 

`$ simple init`

This will interactively help you setup your project for use with this module.

![Setup screenshot](https://raw.githubusercontent.com/karanjthakkar/simple-release/master/setup.png)

Thats it. You're all set to start doing hassle free releases!


## How to Release

Go to your base project and type: 

```
/* Run for every subsequent releases
 * 'type' is a semver release type
 * Suported values for type: major, premajor, minor, preminor, patch, prepatch, or prerelease
 * Default type is 'patch'
 */
$ simple release <type>
```

This will: 

1. pick all the latest commits since the last release for your base project and all your sub-projects 
2. create a new semver tag based on the release type
3. update your package.json with the new tag
4. create a tagged release with a changelog


## Contributions

Suggestions/ideas on how to make it better are most welcome. :)

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