You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<article><h1>Github Release Notes</h1><p><ahref="https://badge.fury.io/js/github-release-notes"><imgsrc="https://badge.fury.io/js/github-release-notes.svg" alt="npm version"></a><br><ahref="http://standardjs.com"><imgsrc="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="js-standard-style"></a><br><ahref="https://travis-ci.org/github-tools/github-release-notes"><imgsrc="https://travis-ci.org/github-tools/github-release-notes.svg?branch=master" alt="Build Status"></a><br><ahref="https://gitter.im/github-release-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><imgsrc="https://badges.gitter.im/github-release-notes/Lobby.svg" alt="Join the chat at https://gitter.im/github-release-notes/Lobby"></a></p>
97
97
<blockquote>
98
98
<p>Node module that generates release notes based on commit messages or closed issues between tags. It also can create a full changelog or add the latest release notes to the existing changelog file.</p>
99
99
</blockquote>
@@ -112,7 +112,7 @@ <h2>Options</h2><p>Following the options for the module:</p>
112
112
<li><code>--action=release|changelog</code> The <strong>gren</strong> action to run. Default: <code>release</code><em>(see details below for changelog generator)</em></li>
113
113
<li><code>--tags=0.1.0|0.2.0,0.1.0</code> A specific tag or the range of tags to build the release notes from.</li>
114
114
<li><code>--ignore-labels=wont_fix|wont_fix,duplicate</code> One or more labels to ignore in the output. Default: <code>false</code><em>(it will still output the issue, just without the specified labels)</em></li>
115
-
<li><code>--ignore-issues-with=wont_fix|wont_fix,duplicate</code> Ignore issues that contains one of the specified issues. Default: <code>false</code></li>
115
+
<li><code>--ignore-issues-with=wont_fix|wont_fix,duplicate</code> Ignore issues that contains one of the specified labels. Default: <code>false</code></li>
116
116
<li><code>--time-wrap=latest|history</code> The release notes you want to include in the changelog. Default: <code>latest</code><em>Only applicable to the <code>changelog</code> action</em></li>
117
117
<li><code>--changelog-filename=CHANGELOG.md</code> The name of the changelog file. Default: <code>CHANGELOG.md</code></li>
118
118
<li><code>--data-source=issues|commits</code> The informations you want to use to build release notes. Default: <code>issues</code></li>
@@ -131,10 +131,8 @@ <h3>Config file</h3><p>You can create a <code>.gren.json</code> file where the t
131
131
"wontfix",
132
132
"duplicate"
133
133
]
134
-
}</code></pre><h3>Templates</h3><p>With <strong>gren</strong> you can decide how you want to output the informations, using the templates.</p>
135
-
<p>The default configuration is the following:</p>
134
+
}</code></pre><h3>Templates</h3><p>You can configure the output of <strong>gren</strong> using templates. Set your own configuration inside the config file, which will be merged with the defaults, shown below:</p>
@@ -150,11 +148,6 @@ <h3>Config file</h3><p>You can create a <code>.gren.json</code> file where the t
150
148
"date": "({{date}})"
151
149
}
152
150
}
153
-
}</code></pre><p>To customise the templates you need to change the <code>.gren.json</code> config file. You only need to specify what you want to change <em>e.g.</em></p>
154
-
<preclass="prettyprint source lang-json"><code>{
155
-
"template": {
156
-
"issue": "- {{name}}"
157
-
}
158
151
}</code></pre><h2>Examples</h2><p>The ways to use <strong>gren</strong> are various.</p>
159
152
<h3>Simple</h3><p>The simple way, just looks for the last tag, gets all the issues closed between that tag and the one before and creates the new release with the generated body.</p>
160
153
<preclass="prettyprint source"><code>gren</code></pre><h3>Commit messages</h3><p>Adding the flag <code>--data-source=commits</code> will change the source of the release notes to be the commit messages.</p>
@@ -169,7 +162,7 @@ <h1>Changelog</h1><h2>v0.4.3 (02/03/2016)</h2><p>[<strong>bug</strong>] This is
169
162
<h3>Generate a full changelog</h3><p>If tou want to generate the whole changelog, you need to use the <code>--time-wrap=history</code>. This will generate a changelog based on issues (or on commit messages if the <code>--data-source=commits</code> is present).</p>
170
163
<p>If you want to override the existing changelog, use <code>--override</code>.</p>
171
164
<p>The usage would then be:</p>
172
-
<preclass="prettyprint source"><code>gren --time-wrap=history --override</code></pre><p>To see a full example of the changelog here <ahref="https://github.com/github-tools/github-release-notes/blob/develop/CHANGELOG.md">CHANGELOG.md</a></p></article>
165
+
<preclass="prettyprint source"><code>gren --action=changelog --time-wrap=history --override</code></pre><p>To see a full example of the changelog here <ahref="https://github.com/github-tools/github-release-notes/blob/develop/CHANGELOG.md">CHANGELOG.md</a></p></article>
0 commit comments