-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathnews.html
246 lines (187 loc) · 11.1 KB
/
news.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>News Workflow — rever 0.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/numpy_friendly.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/jquery.cookie.js"></script>
<script src="_static/cloud.base.js"></script>
<script src="_static/cloud.js"></script>
<link rel="shortcut icon" href="_static/longship.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contributor & Authorship Tracking" href="authorship.html" />
<link rel="prev" title="Notes for using rever" href="usepatterns.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="canonical" href="http://xon.sh/news.html"/>
</head><body>
<div class="relbar-top">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="authorship.html" title="Contributor & Authorship Tracking"
accesskey="N">next</a> </li>
<li class="right" >
<a href="usepatterns.html" title="Notes for using rever"
accesskey="P">previous</a> </li>
<li><a href="index.html">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">News Workflow</a></li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="news-workflow">
<h1>News Workflow<a class="headerlink" href="#news-workflow" title="Permalink to this headline">¶</a></h1>
<p>One of the most helpful features of rever is the <code class="docutils literal notranslate"><span class="pre">changelog</span></code> activity.
This activity produces a changelog by colating <code class="docutils literal notranslate"><span class="pre">news</span></code> files.
The changelog is written into the repo and can be used in the GitHub
release activity.</p>
<p>The workflow for using news is:</p>
<ol class="arabic">
<li><p>Go into the <code class="docutils literal notranslate"><span class="pre">news/</span></code> directory</p></li>
<li><p>Copy the <code class="docutils literal notranslate"><span class="pre">TEMPLATE.rst</span></code> file to another file in the <code class="docutils literal notranslate"><span class="pre">news/</span></code> directory.
We suggest using the branchname:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cp TEMPLATE.rst branch.rst
</pre></div>
</div>
</li>
<li><p>The news files are customizable in the <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> files. However, the
default template looks like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">**</span><span class="n">Added</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Changed</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Deprecated</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Removed</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Fixed</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Security</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
</pre></div>
</div>
<p>In this case you can remove the <code class="docutils literal notranslate"><span class="pre">*</span> <span class="pre"><news</span> <span class="pre">item></span></code> and replace it with your own
news entries, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">**</span><span class="n">Added</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="n">New</span> <span class="n">news</span> <span class="n">template</span> <span class="n">tutorial</span>
<span class="o">**</span><span class="n">Changed</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Deprecated</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Removed</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Fixed</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
<span class="o">**</span><span class="n">Security</span><span class="p">:</span><span class="o">**</span>
<span class="o">*</span> <span class="o"><</span><span class="n">news</span> <span class="n">item</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p>Commit your <code class="docutils literal notranslate"><span class="pre">branch.rst</span></code>.</p></li>
</ol>
<p>Feel free to update this file whenever you want! Please don’t use someone
else’s file name. All of the files in this <code class="docutils literal notranslate"><span class="pre">news/</span></code> directory will be merged
automatically at release time. The <code class="docutils literal notranslate"><span class="pre"><news</span> <span class="pre">item></span></code> entries will be
automatically filtered out too!</p>
<p>Once the project is ready for a release when running the <code class="docutils literal notranslate"><span class="pre">rever</span></code>
command all the files, except the template, in the <code class="docutils literal notranslate"><span class="pre">news</span></code> folder will
be collated and merged into a single changelog file.</p>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html" title="index">
<img class="logo" src="_static/longship-256.png" alt="Logo"/>
</a></p>
<div class="sphinxprev">
<h4>Previous page</h4>
<p class="topless"><a href="usepatterns.html"
title="Previous page">← Notes for using rever</a></p>
</div>
<div class="sphinxnext">
<h4>Next page</h4>
<p class="topless"><a href="authorship.html"
title="Next page">→ Contributor & Authorship Tracking</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/news.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="sidebar-toggle-group no-js">
<button class="sidebar-toggle" id="sidebar-hide" title="Hide the sidebar menu">
«
<span class="show-for-small">hide menu</span>
</button>
<button class="sidebar-toggle" id="sidebar-show" title="Show the sidebar menu">
<span class="show-for-small">menu</span>
<span class="hide-for-small">sidebar</span>
»
</button>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="authorship.html" title="Contributor & Authorship Tracking"
>next</a> </li>
<li class="right" >
<a href="usepatterns.html" title="Notes for using rever"
>previous</a> </li>
<li><a href="index.html">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">News Workflow</a></li>
</ul>
</div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Anthony Scopatz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
<!-- cloud_sptheme 1.4 -->
</body>
</html>