{"id":17540345,"url":"https://github.com/bitwit/grunt-git-flow-bump","last_synced_at":"2025-04-23T22:51:16.160Z","repository":{"id":22088366,"uuid":"25418038","full_name":"bitwit/grunt-git-flow-bump","owner":"bitwit","description":"Version your project according to an opinionated git workflow","archived":false,"fork":false,"pushed_at":"2014-11-27T22:46:30.000Z","size":352,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-18T23:31:49.229Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitwit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-19T04:42:40.000Z","updated_at":"2022-07-15T09:18:10.000Z","dependencies_parsed_at":"2022-08-05T15:30:27.682Z","dependency_job_id":null,"html_url":"https://github.com/bitwit/grunt-git-flow-bump","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwit%2Fgrunt-git-flow-bump","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwit%2Fgrunt-git-flow-bump/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwit%2Fgrunt-git-flow-bump/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitwit%2Fgrunt-git-flow-bump/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitwit","download_url":"https://codeload.github.com/bitwit/grunt-git-flow-bump/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250412544,"owners_count":21426285,"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":[],"created_at":"2024-10-20T22:23:29.945Z","updated_at":"2025-04-23T22:51:16.141Z","avatar_url":"https://github.com/bitwit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#Grunt Git Flow Bump\n\n[![NPM](https://nodei.co/npm/grunt-git-flow-bump.png)](https://nodei.co/npm/grunt-git-flow-bump/)\n\n[![Build Status](https://travis-ci.org/bitwit/grunt-git-flow-bump.svg?branch=master)](https://travis-ci.org/bitwit/grunt-git-flow-bump)\n\n\u003e This bumps your git project according to an opinionated git workflow.\n\n\u003e Set up your MAJOR, and MINOR branch name, from which merges will trigger according versions and\nall other branch merges will be considered PATCH.\n\n\u003e This grunt task has been developed with continuous delivery in mind, when it may be impractical\nto bump manually.\n\n\u003e Never concern yourself with what kind of bumping to give your next version again. Let your workflow\ndo the talking.\n\n## Getting Started\nThis plugin requires Grunt.\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-git-flow-bump --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-git-flow-bump');\n```\n\n### Configuration\nIn your project's Gruntfile, add a section named `gitFlowBump` to the data object passed into `grunt.initConfig()`. The options (and defaults) are:\n\n```js\ngrunt.initConfig({\n  gitFlowBump: {\n    options: {\n      files: ['package.json'],\n      updateConfigs: [], // array of config properties to update (with files)\n\n      majorBranch: 'remotes/origin/release',\n      minorBranch: 'remotes/origin/develop',\n      patchBranch: '*',\n      masterOnly: true,\n\n      forceGitVersion: false,\n      gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d',\n\n      postBumpTasks: [], //tasks to run between versioning and git tag, commit, push\n\n      commit: true,\n      commitMessage: 'Release v%VERSION%',\n      commitFiles: ['package.json'],\n\n      createTag: true,\n      tagName: 'v%VERSION%',\n      tagMessage: 'Version %VERSION%',\n\n      push: true,\n      pushTo: 'upstream'\n\n\n    }\n  },\n})\n```\n\n### Options\n\n#### options.files\nType: `Array`\nDefault value: `['package.json']`\n\nMaybe you wanna bump 'component.json' instead? Or maybe both: `['package.json', 'component.json']`? Can be either a list of files to bump (an array of files) or a grunt glob (e.g., `['*.json']`).\n\n### options.minorBranch\n\n### options.majorBranch\n\n#### options.updateConfigs\nType: `Array`\nDefault value: `[]`\n\nSometimes you load the content of `package.json` into a grunt config. This will update the config property, so that even tasks running in the same grunt process see the updated value.\n\n```js\ngitFlowBump: {\n  files:         ['package.json', 'component.json'],\n  updateConfigs: ['pkg',          'component']\n}\n```\n\n#### options.commit\nType: `Boolean`\nDefault value: `true`\n\nShould the changes be committed? False if you want to do additional things.\n\n#### options.commitMessage\nType: `String`\nDefault value: `Release v%VERSION%`\n\nIf so, what is the commit message ? You can use `%VERSION%` which will get replaced with the new version.\n\n#### options.commitFiles\nType: `Array`\nDefault value: `['package.json']`\n\nAn array of files that you want to commit. You can use `['-a']` to commit all files.\n\n#### options.createTag\nType: `Boolean`\nDefault value: `true`\n\nCreate a Git tag?\n\n#### options.tagName\nType: `String`\nDefault value: `v%VERSION%`\n\nIf `options.createTag` is set to true, then this is the name of that tag (`%VERSION%` placeholder is available).\n\n#### options.tagMessage\nType: `String`\nDefault value: `Version %VERSION%`\n\nIf `options.createTag` is set to true, then yep, you guessed right, it's the message of that tag - description (`%VERSION%` placeholder is available).\n\n#### options.push\nType: `Boolean`\nDefault value: `true`\n\nPush the changes to a remote repo?\n\n#### options.pushTo\nType: `String`\nDefault value: `upstream`\n\nIf `options.push` is set to true, which remote repo should it go to?\n\n#### options.gitDescribeOptions\nType: `String`\nDefault value: `--tags --always --abbrev=1 --dirty=-d`\n\nOptions to use with `$ git describe`\n\n#### options.globalReplace\nType: `Boolean`\nDefault value: `false`\n\nReplace all occurrences of the version in the file. When set to `false`, only the first occurrence will be replaced.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitwit%2Fgrunt-git-flow-bump","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitwit%2Fgrunt-git-flow-bump","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitwit%2Fgrunt-git-flow-bump/lists"}