https://github.com/coderaiser/wisdom
:gift: Tool for publishing releases to github and npm
https://github.com/coderaiser/wisdom
changelog npm publish publishing release wisdom
Last synced: about 2 months ago
JSON representation
:gift: Tool for publishing releases to github and npm
- Host: GitHub
- URL: https://github.com/coderaiser/wisdom
- Owner: coderaiser
- License: mit
- Created: 2014-10-17T14:49:16.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2026-01-18T19:09:55.000Z (2 months ago)
- Last Synced: 2026-01-19T03:33:04.275Z (2 months ago)
- Topics: changelog, npm, publish, publishing, release, wisdom
- Language: JavaScript
- Homepage:
- Size: 375 KB
- Stars: 19
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# Wisdom [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]
[NPMIMGURL]: https://img.shields.io/npm/v/wisdom.svg?style=flat
[BuildStatusURL]: https://github.com/coderaiser/wisdom/actions?query=workflow%3A%22Node+CI%22 "Build Status"
[BuildStatusIMGURL]: https://github.com/coderaiser/wisdom/workflows/Node%20CI/badge.svg
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/wisdom "npm"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
Tool for publishing releases to github and npm according to [Semantic Versionin](http://semver.org "Semantic Versioning").
🎁**Wisdom** does next things:
- set env variable `$wisdom_version` and `$WISDOM_VERSION` with future version
- run command from `scripts.wisdom` of `package.json` (if exist);
- run command from `scripts.wisdom:type` of `package.json` (if exist);
- [changelog](http://github.com/coderaiser/changelog-io "ChangeLog");
- [version](http://github.com/coderaiser/version-io "Version") in `package.json`;
- tag;
- [release on github](https://github.com/coderaiser/node-grizzly "Grizzly");
- push to github;
- publish to npm;
- run command from `scripts.wisdom:done` of `package.json` (if exist);
`package.json` should contain next properties,
**when publish enabled:**
```json
{
"publishConfig": {
"access": "public"
}
}
```
**when releases enabled:**
`repository` field should be set:
```json
{
"repository": {
"type": "git",
"url": "git://github.com/coderaiser/wisdom.git"
}
}
```
Before executing `wisdom`, `wisdom:type` and `wisdom:done` scripts will be expanded via [redrun](https://github.com/coderaiser/redrun) which will speed things up.
Here is list of commands that should be executed to get same result:
```sh
changelog {{ version }}
version {{ version }}
git add --all
git commit -m "feature(package) v{{ version }}"
git push origin {{ branch }}
git tag v{{ version }}
git push origin v{{ version }}
grizzly -tn "token from url" \
-r grizzly -o {{ owner }} -t {{ version }} \
-n "{{ repo }} {{ version }}" -b "changelog"
npm publish
```
## Install
`npm i wisdom -g`
## How to use?
```
$ wisdom
Usage: wisdom [patch|minor|major]
Options:
--dry-run show tasks to run without actually running
--force do not ask before publishin major
-h, --help display this help and exit
-v, --version output version information and exit
```
## Configuration
When you need configure `wisdom` you could declare them in `package.json` (**with defaults set**):
```json
{
"changelog": true,
"commitType": "colon|paren",
"tag": true,
"release": true,
"releaseTriesCount": 10,
"private": false,
"branch": "master",
"scripts": {
"wisdom": "echo 'do something before starting'",
"wisdom:type": "echo 'do something before starting and add --patch, --minor or --major argument'",
"wisdom:build": "echo 'do something before publish'",
"wisdom:done": "echo 'do something after publish'"
}
}
```
## License
MIT