Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/djanta/djantajs-release-coverage
djanta.io releasing tool module based on node implementation
https://github.com/djanta/djantajs-release-coverage
bump bumping djanta djantajs release tag version versioning
Last synced: about 1 month ago
JSON representation
djanta.io releasing tool module based on node implementation
- Host: GitHub
- URL: https://github.com/djanta/djantajs-release-coverage
- Owner: djanta
- License: mit
- Created: 2018-01-03T02:50:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T03:12:06.000Z (about 2 years ago)
- Last Synced: 2023-03-02T01:25:55.333Z (almost 2 years ago)
- Topics: bump, bumping, djanta, djantajs, release, tag, version, versioning
- Language: JavaScript
- Homepage: https://djantajs.io
- Size: 628 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# djantaio-tools-bump
[](https://www.npmjs.com/package/djantaio-tools-bump)
[](https://www.npmjs.com/package/djantaio-tools-bump)
[](https://github.com/djanta/djantaio-tools-bump/tags)
[](https://github.com/djanta/djantaio-tools-bump/releases)
[](https://travis-ci.org/djanta/djantaio-tools-bump)
[](https://david-dm.org/bigstickcarpet/djantaio-tools-bump)
[](LICENSE)
[](https://gitter.im/djantajs/tools?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
> Uses djanta platform plugin bumping tools.
#### Automate your release process with a single command that can:
* Optionally prompt for the type of version bump (major, minor, revision, beta, etc.)
* Bump the version number in all of your JSON manifests, including:
- `package.json`
- `bower.json`
- `component.json`
* Replace version number strings in text files, including:
- config files
- source code
- README files
- license files
* Run your `preversion`, `version`, and `postversion` scripts
* Commit changes to GIT
* Tag the commit with the version number
* Push the commit to remote
Installation
--------------------------
You can install `djantaio-tools-bump` via [npm](https://docs.npmjs.com/getting-started/what-is-npm).
```bash
npm install -g djantaio-tools-bump
```
Usage
--------------------------
```bash
Usage: djantaio-bump [options]
Options:
-f, --file Define where to load the roadmap from [required] [default: "./release.yml"]
-u, --url-prefix Specify the Git repository host prefix
-t, --semver-tag Define the default semver strategy to use
-M, --master-branch Specify the default working repositiory defaut master branch name
-D, --draft-branch Specify the branch that has to be used as the default working branch
-a, --archetype Use this option to define what kind of the project artifact should be exclusivly bump [default: "npm"]
-c, --changelog Use this option to define whether or not the change log file should be generated
-e, --roadmap Specify the roadmap list to execute [array]
-p, --git-project Specify the local Git project directory
--help Show help [boolean]
Examples:
$ djantaio-bump --file ...
$ djantaio-bump --file -e -e -e ...
$ djantaio-bump --file --semver-tag ...
```
Manifest Overview
--------------------------
As specified with the option `--file`, here below how you can declare your manifest file
```yaml
defaults:
url: [email protected]:djanta
origin: origin
changelog: true
archetype: npm
branch:
draft: develop
master: master
version: patch
prerelease:
repositories:
-
tag: true
name: djantaio-bump-test
version: prerelease
archetype: npm
branch:
master: master
draft: develop
command:
- "npm install"
- "npm run compile"
dependencies:
-
name: lodash
version: latest
- dateutil
```
### Options
#### options.defaults
**Type**: `Object`
The default configuration remain the top level where you'd like to define all the common properties shared by bumping strategy such as your repository host url.
##### options.defaults.url
**Type**: `String`
**Default value**: ``
A string value that define your git repository host url. The property can overrided by the command line `-u, --url-prefix`
##### options.defaults.origin
**Type**: `String`
**Default value**: `origin`
A string value given to override the default repository url name.
#### options`.<#roadmap>`
**Type**: `Object`
Here's will take place your roadmap configuration.
##### options`.<#roadmap>`.repositories
**Type**: `Arrays`
Define the list of the target repository which should be bumped
###### options`.<#roadmap>`.repositories.tag
**Type**: `bool`
**Default value**: `true`
Define whether the current repository should be tagged. This's basically synomym of `enabled`
###### options`.<#roadmap>`.repositories.name
**Type**: `String`
**Default value**: ` `
_**Required**_: `true`
Here's where you can define the target repository name without the `.git` extension.
###### options`.<#roadmap>`.repositories.archetype
**Type**: `String`
**Default value**: `npm`
_**Required**_: `true`
Define which archetype should be use to bump you project version. By the default `npm` archetype will be used. However, this can be overrided with the comment line `--archetype`
###### options`.<#roadmap>`.repositories.branch
**Type**: `Object`
**Default value**:
```yaml
branch:
draft: develop
master: master
```
_**Required**_: `true`
The branch configuration scope provide the way through to configure the working branch and the master branch.
- `draft` : the draft branch represent the current working branch where to tag from as the
- `master`: branch reprsent to merge to after the working branch has been bumped and tagged
Either `branch.draft` and `branch.master` can be overrided with the command lines `--draft-branch|-D` and `--master-branch|-M`
###### options`.<#roadmap>`.repositories.commad
**Type**: `Array`
**Default value**: ` `
_**Required**_: `false`
The options `command` define a list of commad which should executed after bumping your project and before it's become tagged
###### options`.<#roadmap>`.repositories.dependencies
**Type**: `Array`
**Default value**:
```yaml
branch:
draft: develop
master: master
```
_**Required**_: `false`
Version Scripts
--------------------------
`djantaio-tools-bump` will execute your `preversion`, `version`, and `postversion` scripts, just like [the `npm version` command](https://docs.npmjs.com/cli/version) does. If your `package.json` file contains any or all of these scripts, then they will be executed in the following order:
- The `preversion` script runs before the version is updated (and before the version prompt is shown)
- The `version` script runs after the version is updated, but _before_ `git commit` and `git tag`
- The `postversion` script runs after `git commit` and `git tag`, but _before_ `git push`
Contributing
--------------------------
I welcome any contributions, enhancements, and bug-fixes. [File an issue](https://github.com/djanta/djantaio-tools-bump/issues) on GitHub and [submit a pull request](https://github.com/djantaio/djantaio-tools-bump/pulls).
#### Building
To build the project locally on your computer:
1. __Clone this repo__
```bash
git clone https://github.com/djanta/djantaio-tools-bump.git
```
2. __Install dependencies__
```bash
npm install
```
3. __Run the tests__
```bash
npm test
```
License
--------------------------