Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ulivz/quick-publish

Shipped a standard npm publish workflow with one click.
https://github.com/ulivz/quick-publish

cli npm npm-publish polyrepo publish release

Last synced: 22 days ago
JSON representation

Shipped a standard npm publish workflow with one click.

Host: GitHub
URL: https://github.com/ulivz/quick-publish
Owner: ulivz
License: mit
Created: 2022-01-13T16:07:46.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-03-08T06:28:01.000Z (over 1 year ago)
Last Synced: 2024-05-01T22:43:06.778Z (6 months ago)
Topics: cli, npm, npm-publish, polyrepo, publish, release
Language: TypeScript
Homepage:
Size: 298 KB
Stars: 12
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# quick-publish

[![npm version](https://badgen.net/npm/v/quick-publish)](https://npm.im/quick-publish)

Shipped a standard `npm publish` workflow with one click.

## Motivation

As a maintainer for a large number of NPM packages, it will be very cumbersome if you manually input the semantic version, generate changelog, git and npm tag etc., this tooling is to help you do all these things with one click.

## Features

- Semantic version selection.
- Create git tag.
- Create remote git tag.
- Create npm tag.
- Generate or update `CHANGELOG.md`

## Install

```bash
npm i quick-publish -g # Global installation
npm i quick-publish -D # Local installation
```

## Usage

- Create a one-click release flow:

```bash
publish
```

- Display help:

```bash
Usage:
$ publish

Commands:
Shipped a standard `npm publish` workflow with one click.

Options:
--depcost Generate or update `DEPCOST.md`, defaults to `false`
--push Execute git push & tag push to remote git origin, defaults to `true`
-h, --help Display this message
-v, --version Display version number
```

## Credits

`quick-publish` wouldn't exist without the inspirations from following projects:

- [conventional-changelog-cli](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)

## License