# ape-releasing

> ape framework module for releasing tasks.

Latest version **5.0.7** (published 2019-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install ape-releasing
pnpm add ape-releasing
yarn add ape-releasing
bun add ape-releasing
```

## 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 | 5.0.7 |
| Published | 2019-02-24 |
| First published | 2015-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 7 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | ape, releasing |

## Links

- npm: https://www.npmjs.com/package/ape-releasing
- Repository: https://github.com/ape-repo/ape-releasing
- Homepage: https://github.com/ape-repo/ape-releasing#readme
- Issues: https://github.com/ape-repo/ape-releasing/issues
- npm.io page: https://npm.io/package/ape-releasing

## Dependencies (7)

- [argx](https://npm.io/package/argx.md) ^4.0.0
- [taggit](https://npm.io/package/taggit.md) ^2.0.3
- [execcli](https://npm.io/package/execcli.md) ^5.0.6
- [versionup](https://npm.io/package/versionup.md) ^3.0.3
- [ape-asking](https://npm.io/package/ape-asking.md) ^3.0.4
- [colorprint](https://npm.io/package/colorprint.md) ^5.0.0
- [stringcase](https://npm.io/package/stringcase.md) ^4.3.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 5.0.7 (latest) — 2019-02-24
- 5.0.6 — 2019-02-24
- 5.0.5 — 2019-02-24
- 5.0.4 — 2019-02-24
- 5.0.3 — 2019-02-24
- 5.0.2 — 2019-02-24
- 5.0.1 — 2019-02-23
- 5.0.0 — 2018-10-31
- 4.0.4 — 2016-07-30
- 4.0.3 — 2016-07-30
- 4.0.2 — 2016-07-17
- 4.0.1 — 2016-06-26
- 3.1.1 — 2016-05-11
- 3.1.0 — 2016-05-11
- 3.0.9 — 2016-05-11
- … 32 more at https://npm.io/package/ape-releasing/versions

## README

ape-releasing
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![Dependency Status][bd_gemnasium_shield_url]][bd_gemnasium_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/ape-repo/ape-releasing
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-releasing
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-releasing.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-releasing
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-releasing.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-releasing/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-releasing
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-releasing.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-releasing.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-releasing
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-releasing.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-releasing
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-releasing.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

ape framework module for releasing tasks.

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
----

### Release a npm Package

`.apeReleasing.releasePackage()` function will do:

1. Create a git tag and push to remote.
2. Publish package to npm.
3. Increment package.json version number.
4. Commit and push git local changes.

```javascript
#!/usr/bin/env node
'use strict'

const apeReleasing = require('ape-releasing')

// Release a npm package
apeReleasing.releasePackage({
  beforeRelease: [ // Scripts run before releasing
    './ci/build.js',
    './ci/test.js'
  ]
}).then(() => {
  /* ... */
})

```



<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Options.md.hbs" Start -->

<a name="section-doc-guides-03-options-md"></a>

Options
-------

Available options for `.releasePackage(options, callback)` method.

| Name | Type | Value |
| ---- | ----- | ----- |
| beforeRelease | function[] | Tasks to do before release |
| afterRelease | function[] | Tasks to do after release |
| skipInteractive | boolean | Skip confirming before releasing. |



<!-- Section from "doc/guides/03.Options.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/ape-repo/ape-releasing/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [ape-repo][ape_repo_url]
+ [npm][npm_url]

[ape_repo_url]: https://github.com/ape-repo
[npm_url]: https://www.npmjs.com/

<!-- Links End -->

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