Skip to content

Commit 58d7b10

Browse files
committed
Readme.md updated
1 parent c28dd2f commit 58d7b10

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,44 @@
11
# grunt-github-release-notes
22

3-
Grunt module to publish release notes based on commits between the last two tags.
3+
> Grunt module to publish release notes based on commits between the last two tags.
4+
> This module is using [github-release-notes](https://github.com/alexcanessa/github-release-notes).
5+
6+
## Getting Started
7+
This plugin requires Grunt `~0.4.5`
8+
9+
```shell
10+
npm install grunt-github-release-notes --save-dev
11+
```
12+
13+
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
14+
15+
```js
16+
grunt.loadNpmTasks('grunt-github-release-notes');
17+
```
18+
19+
## The "release" task
20+
21+
### Overview
22+
In your project's Gruntfile, add a section named `hello` to the data object passed into `grunt.initConfig()`.
23+
**All `token`, `username` and `repo` are required.**
24+
25+
```js
26+
gren: {
27+
release: {
28+
options: {
29+
token: {github_token},
30+
username: {github_username},
31+
repo: {github_repo_name}
32+
}
33+
}
34+
}
35+
```
36+
37+
To generate a github token, follow [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/);
38+
39+
### Optionals
40+
There are optional arguments such as:
41+
42+
- `draft: true` To set the release as a draft. Default: `false`
43+
- `prerelease: true` To set the release as a prerelease. Default: `false`
44+
- `prefix: 'v'` Add a prefix to the tag version `e.g. v1.0.1`

0 commit comments

Comments
 (0)