百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
G

grunt-release

> 编程语言
开源

发布基于 Node 的项目的新版本

387 stars0 点赞2 次浏览
访问官网GitHub

工具介绍

发布基于 Node 的项目的新版本

grunt-release

Grunt plugin for automating all the release steps of your node lib or bower component, with optional publishing to npm.

Repetition Killed the Cat

Releasing a new version of your killer Node/Bower/Component/JS lib looks something like this:

  1. bump the version in your package.json file.
  2. stage the package.json file's change.
  3. commit that change with a message like "release 0.6.22".
  4. create a new git tag for the release.
  5. push the changes out to GitHub.
  6. also push the new tag out to GitHub.
  7. create a .zip release on GitHub.
  8. publish the new version to npm.

Cool, right? No! What's wrong with you? Automate all that:

bash
grunt release

Done. No more GitHub issues from angry people reminding you how often you forget to do one or more of the steps.

Setup

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

bash
npm install grunt-release --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

javascript
grunt.loadNpmTasks('grunt-release');

Using grunt-release

Patch Release:

bash
grunt release

or

bash
grunt release:patch

Minor Release:

bash
grunt release:minor

Major Release:

bash
grunt release:major

Specific Version Release:

bash
grunt release:1.2.3

Pre-release

bash
grunt release:prerelease

prerelease will just update the number after MAJOR.MINOR.PATCH (eg: 1.0.0-1) If you want to add an alphanumeric identifier, you will need to add it by hand. Example: add -alpha.0 to get something like 1.0.0-alpha.0. Calling grunt release:prerelease will just update the last number to 1.0.0-alpha.1.

Releasing Unstable/Beta Versions Sometimes it is useful to publish an 'unstable' or 'beta' version to npm, while leaving your last stable release as the default that gets installed on an npm install. npm accomplishes this using the --tag myUnstableVersion flag. You can enable this flag in grunt-release either by setting the npmtag option:

javascript
  release: {
    options: {
      npmtag: 'canary',
    }
  }

or by passing the CLI arg:

bash
grunt release --npmtag canary

NOTE: If the tag you pass is true, then the tag will be the new version number after the bump. Otherwise it will be the string you provided.

Bump multiple files at once

Sometimes you may need to bump multiple files while releasing.

javascript
  release: {
    options: {
      additionalFiles: ['bower.json']
    }
  }

You can also provide multiple files in this array or provide a string with multiple file paths separated by comma (,).

The version to bump is set in the master file defined with option 'file' (default : package.json). This version will be propagated to every additionalFiles.

Dry Run: To see what grunt-release does, without really changing anything, use --no-write option.

bash
grunt release --no-write

You'll see something like:

>> Release dry run
>> bumped version to 0.8.0
>> staged package.json
>> committed package.json
>> created new git tag: 0.8.0
>> pushed to remote git repo
>> pushed new tag 0.8.0 to remote git repo
>> published version 0.8.0 to npm
>> created 0.8.0 release on github.

Done, without errors.

Options

The following are all the release steps, you can disable any you need to:

…

If you want to use multiline commit messages just pass an array to the commitMessage option instead of a string.

Notes on queued tasks

By default, the queued tasks ran through the beforeBump, afterBump, beforeRelease, afterRelease options will not inherit the flags specified when the release task is ran. To preserve those flags, you can optionally pass an object to those arrays in the following format:

javascript
{
   name: 'taskName',
   preserveFlags: true // defaults to false
}

You can still pass only strings to that array, or mix the two as need be. For example:

javascript
  release: {
    options: {
      beforeRelease: ['oneTask', { name: 'anotherTask', preserveFlags: true }]
    }
  }

Notes on GitHub Releases:

  1. Yes, you have to use environment variables.
  2. The GitHub Releases API is still unstable and may change in the future.
  3. You should use an environment variable to set an access token and "link" it via accessTokenVar.
  4. You can use environment variables for username (referenced in usernameVar) and password (passwordVar).
  5. We don't encourage you to use username and password for the GitHub release.

For node libs, leave file option blank as it will default to package.json. For Bower components, set it to bower.json.

License

MIT

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

JavaScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言