{"id":22245405,"url":"https://github.com/djanta/djantajs-release-coverage","last_synced_at":"2025-03-25T11:20:35.632Z","repository":{"id":39786857,"uuid":"116083146","full_name":"djanta/djantajs-release-coverage","owner":"djanta","description":"djanta.io releasing tool module based on node implementation","archived":false,"fork":false,"pushed_at":"2022-12-07T03:12:06.000Z","size":643,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-30T10:22:04.597Z","etag":null,"topics":["bump","bumping","djanta","djantajs","release","tag","version","versioning"],"latest_commit_sha":null,"homepage":"https://djantajs.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/djanta.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-03T02:50:53.000Z","updated_at":"2020-07-30T12:48:36.000Z","dependencies_parsed_at":"2022-09-17T10:51:49.207Z","dependency_job_id":null,"html_url":"https://github.com/djanta/djantajs-release-coverage","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djanta%2Fdjantajs-release-coverage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djanta%2Fdjantajs-release-coverage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djanta%2Fdjantajs-release-coverage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djanta%2Fdjantajs-release-coverage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/djanta","download_url":"https://codeload.github.com/djanta/djantajs-release-coverage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245449652,"owners_count":20617190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bump","bumping","djanta","djantajs","release","tag","version","versioning"],"created_at":"2024-12-03T05:14:16.350Z","updated_at":"2025-03-25T11:20:35.596Z","avatar_url":"https://github.com/djanta.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# djantaio-tools-bump\n\n[![npm version](https://img.shields.io/npm/v/djantaio-tools-bump?style=flat-square)](https://www.npmjs.com/package/djantaio-tools-bump)\n[![npm downloads](https://img.shields.io/npm/dm/djantaio-tools-bump.svg?style=flat-square)](https://www.npmjs.com/package/djantaio-tools-bump)\n[![GitHub tag](https://img.shields.io/github/tag/djanta/djantaio-tools-bump)](https://github.com/djanta/djantaio-tools-bump/tags)\n[![Github All Releases](https://img.shields.io/github/downloads/djanta/djantaio-tools-bump/latest/total.svg)](https://github.com/djanta/djantaio-tools-bump/releases)\n[![Build Status](https://travis-ci.org/djanta/djantaio-tools-bump.svg?branch=master)](https://travis-ci.org/djanta/djantaio-tools-bump)\n[![Dependencies](https://david-dm.org/djanta/djantaio-tools-bump.svg)](https://david-dm.org/bigstickcarpet/djantaio-tools-bump)\n[![License](https://img.shields.io/npm/l/djantaio-tools-bump.svg)](LICENSE)\n[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/djantajs/tools?utm_source=share-link\u0026utm_medium=link\u0026utm_campaign=share-link)\n\n\u003e Uses djanta platform plugin bumping tools.\n\n#### Automate your release process with a single command that can:\n\n * Optionally prompt for the type of version bump (major, minor, revision, beta, etc.)\n * Bump the version number in all of your JSON manifests, including:\n    -  `package.json`\n    -  `bower.json`\n    -  `component.json`\n * Replace version number strings in text files, including:\n    -  config files\n    -  source code\n    -  README files\n    -  license files\n * Run your `preversion`, `version`, and `postversion` scripts\n * Commit changes to GIT\n * Tag the commit with the version number\n * Push the commit to remote\n\n\nInstallation\n--------------------------\nYou can install `djantaio-tools-bump` via [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```bash\nnpm install -g djantaio-tools-bump\n```\n\n\nUsage\n--------------------------\n\n```bash\nUsage: djantaio-bump [options]\n\nOptions:\n\n  -f, --file           Define where to load the roadmap from  [required] [default: \"./release.yml\"]\n  -u, --url-prefix     Specify the Git repository host prefix\n  -t, --semver-tag     Define the default semver strategy to use\n  -M, --master-branch  Specify the default working repositiory defaut master branch name\n  -D, --draft-branch   Specify the branch that has to be used as the default working branch\n  -a, --archetype      Use this option to define what kind of the project artifact should be exclusivly bump  [default: \"npm\"]\n  -c, --changelog      Use this option to define whether or not the change log file should be generated\n  -e, --roadmap        Specify the roadmap list to execute  [array]\n  -p, --git-project    Specify the local Git project directory\n  --help               Show help  [boolean]\n\nExamples:\n\n  $ djantaio-bump --file \u003cMANIFEST FILE\u003e ...\n  $ djantaio-bump --file \u003cMANIFEST FILE\u003e -e \u003cROADMAP NAME\u003e -e \u003cROADMAP NAME2\u003e -e \u003cROADMAP n...\u003e ...\n  $ djantaio-bump --file \u003cMANIFEST FILE\u003e --semver-tag \u003cYOUR TAEGET VERSION\u003e ...\n```\n\nManifest Overview\n--------------------------\nAs specified with the option `--file`, here below how you can declare your manifest file\n\n```yaml\ndefaults:\n  url: git@github.com:djanta\n  origin: origin\n  changelog: true\n  archetype: npm\n  branch:\n    draft: develop\n    master: master\n  version: patch\n  \nprerelease:\n  repositories:\n    -\n      tag: true\n      name: djantaio-bump-test\n      version: prerelease\n      archetype: npm\n      branch:\n        master: master\n        draft: develop\n      command:\n        - \"npm install\"\n        - \"npm run compile\"\n      dependencies:\n        -\n          name: lodash\n          version: latest\n        - dateutil\n```\n\n### Options\n\n#### options.defaults\n**Type**: `Object`\n\nThe 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.\n\n##### options.defaults.url\n**Type**: `String` \u003cbr/\u003e\n**Default value**: ``\n\nA string value that define your git repository host url. The property can overrided by the command line `-u, --url-prefix`\n\n##### options.defaults.origin\n**Type**: `String` \u003cbr/\u003e\n**Default value**: `origin`\n\nA string value given to override the default repository url name.\n\n#### options`.\u003c#roadmap\u003e`\n**Type**: `Object`\n\nHere's will take place your roadmap configuration.\n\n##### options`.\u003c#roadmap\u003e`.repositories\n**Type**: `Arrays` \u003cbr/\u003e\n\nDefine the list of the target repository which should be bumped\n\n###### options`.\u003c#roadmap\u003e`.repositories.tag\n**Type**: `bool` \u003cbr/\u003e\n**Default value**: `true`\n\nDefine whether the current repository should be tagged. This's basically synomym of `enabled`\n\n###### options`.\u003c#roadmap\u003e`.repositories.name\n**Type**: `String` \u003cbr/\u003e\n**Default value**: ` ` \u003cbr/\u003e\n_**Required**_: `true`\n\nHere's where you can define the target repository name without the `.git` extension.\n\n###### options`.\u003c#roadmap\u003e`.repositories.archetype\n**Type**: `String` \u003cbr/\u003e\n**Default value**: `npm` \u003cbr/\u003e\n_**Required**_: `true`\n\nDefine 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`\n\n###### options`.\u003c#roadmap\u003e`.repositories.branch\n**Type**: `Object` \u003cbr/\u003e\n**Default value**: \n```yaml\n  branch:\n    draft: develop\n    master: master\n```\n_**Required**_: `true`\n\nThe branch configuration scope provide the way through to configure the working branch and the master branch. \n  - `draft` : the draft branch represent the current working branch where to tag from as the\n  - `master`: branch reprsent to merge to after the working branch has been bumped and tagged \n\nEither `branch.draft` and `branch.master` can be overrided with the command lines `--draft-branch|-D` and `--master-branch|-M`\n\n###### options`.\u003c#roadmap\u003e`.repositories.commad\n**Type**: `Array` \u003cbr/\u003e\n**Default value**: ` ` \u003cbr/\u003e\n_**Required**_: `false`\n\nThe options `command` define a list of commad which should executed after bumping your project and before it's become tagged\n\n###### options`.\u003c#roadmap\u003e`.repositories.dependencies\n**Type**: `Array` \u003cbr/\u003e\n**Default value**: \n```yaml\n  branch:\n    draft: develop\n    master: master\n```\n_**Required**_: `false`\n\nVersion Scripts\n--------------------------\n`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:\n\n  - The `preversion` script runs before the version is updated (and before the version prompt is shown)\n  - The `version` script runs after the version is updated, but _before_ `git commit` and `git tag`\n  - The `postversion` script runs after `git commit` and `git tag`, but _before_ `git push`\n\nContributing\n--------------------------\nI 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).\n\n#### Building\nTo build the project locally on your computer:\n\n1. __Clone this repo__\n```bash\ngit clone https://github.com/djanta/djantaio-tools-bump.git\n```\n\n2. __Install dependencies__\n```bash\nnpm install\n```\n\n3. __Run the tests__\n```bash\nnpm test\n```\n\n\n\nLicense\n--------------------------\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjanta%2Fdjantajs-release-coverage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjanta%2Fdjantajs-release-coverage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjanta%2Fdjantajs-release-coverage/lists"}