/usr/share/doc/python-pywt-doc/html/dev/how_to_release.html is in python-pywt-doc 0.5.1-1.1ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Guidelines for Releasing PyWavelets — PyWavelets Documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.5.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within PyWavelets Documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Resources" href="../resources.html" />
<link rel="prev" title="Testing" href="testing.html" />
<meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations."/>
<meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt"/>
<meta name="author" content="Filip Wasilewski"/>
<meta name="Distribution" content="Global"/>
<meta name="Robots" content="INDEX,FOLLOW"/>
<script type="text/javascript">
(function ($) {
$(document).ready(function () {
$("#toggle-edit-info").click(function (e) {
e.preventDefault();
$("#edit-info").toggle();
});
});
})(jQuery);
</script>
</head>
<body role="document">
<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="../resources.html" title="Resources"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="testing.html" title="Testing"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Home »</a></li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Development notes</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="guidelines-for-releasing-pywavelets">
<h1>Guidelines for Releasing PyWavelets<a class="headerlink" href="#guidelines-for-releasing-pywavelets" title="Permalink to this headline">¶</a></h1>
<p>The following are guidelines for preparing a release of PyWavelets. The
notation vX.X.X in the commands below would be replaced by the actual release
number.</p>
<div class="section" id="updating-the-release-notes">
<h2>updating the release notes<a class="headerlink" href="#updating-the-release-notes" title="Permalink to this headline">¶</a></h2>
<p>Prior to the release, make sure the release notes are up to date.</p>
<p>author lists can be generated via:</p>
<p><code class="docutils literal"><span class="pre">`python</span>  <span class="pre">./util/authors.py</span> <span class="pre">vP.P.P..`</span></code>
(where vP.P.P is the previous release number)</p>
<p>and the lists of Issues closed and PRs merged via:</p>
<p><code class="docutils literal"><span class="pre">`python</span> <span class="pre">./util/gh_lists.py</span> <span class="pre">vX.X.X`</span></code> (script requires Python 2.X to run)</p>
</div>
<div class="section" id="tag-the-release-and-trigger-the-build-of-windows-wheels">
<h2>Tag the release and trigger the build of Windows wheels<a class="headerlink" href="#tag-the-release-and-trigger-the-build-of-windows-wheels" title="Permalink to this headline">¶</a></h2>
<p>Change ISRELEASED to TRUE in <cite>setup.py</cite> and commit.</p>
<p>Appveyor will build wheels for windows. If the commit with ISRELEASED=True
is submitted as a PR, the wheels can be downloaded from appveyor once it has
run on the PR. They can be found under the “Artifacts” tab in the Appveyor
interface. These should be downloaded so that they can later be uploaded to
pypi.python.org.</p>
<p>Tag the release via:</p>
<p><code class="docutils literal"><span class="pre">`git</span> <span class="pre">tag</span> <span class="pre">-s</span> <span class="pre">vX.X.X`</span></code></p>
<p>Then push the vX.X.X tag to master.</p>
</div>
<div class="section" id="create-the-source-distribution">
<h2>Create the source distribution<a class="headerlink" href="#create-the-source-distribution" title="Permalink to this headline">¶</a></h2>
<p>Remove untracked files and directories via git clean.
<strong>Warning:</strong> This will delete files & directories that are not under version
control so you may want to do a dry run first by adding -n, so you can see what
will be removed:</p>
<p><code class="docutils literal"><span class="pre">`git</span> <span class="pre">clean</span> <span class="pre">-xfdn`</span></code></p>
<p>Then run without -n:</p>
<p><code class="docutils literal"><span class="pre">`git</span> <span class="pre">clean</span> <span class="pre">-xfd`</span></code></p>
<p>Create the source distribution files via:</p>
<p><code class="docutils literal"><span class="pre">`python</span> <span class="pre">setup.py</span> <span class="pre">sdist</span> <span class="pre">--formats=gztar,zip`</span></code></p>
</div>
<div class="section" id="upload-the-release-to-pypi">
<h2>Upload the release to pypi<a class="headerlink" href="#upload-the-release-to-pypi" title="Permalink to this headline">¶</a></h2>
<p>The binary Windows wheels downloaded from Appveyor (see above) should
also be placed into the /dist subfolder along with the sdist archives.</p>
<p>The wheels and source distributions created above can all be securely uploaded
to pypi.python.org using twine:</p>
<p><code class="docutils literal"><span class="pre">`twine</span> <span class="pre">upload</span> <span class="pre">-s</span> <span class="pre">dist/*`</span></code></p>
</div>
<div class="section" id="upload-the-documentation-to-pypi">
<h2>Upload the documentation to pypi<a class="headerlink" href="#upload-the-documentation-to-pypi" title="Permalink to this headline">¶</a></h2>
<p>The documentation on readthedocs (<a class="reference external" href="http://pywavelets.readthedocs.org">http://pywavelets.readthedocs.org</a>) will have
been automatically generated, but the documentation linked from pypi.python.org
(<a class="reference external" href="http://pythonhosted.org/PyWavelets/">http://pythonhosted.org/PyWavelets/</a>) will need to be manually updated. This
can be done by building the documentation locally and zipping ‘doc/build/html’
so that index.html is at the top level of the archive. This archive can then be
uploaded in the “files” section of the PyWavelets page on pypi.</p>
</div>
<div class="section" id="create-the-release-on-github">
<h2>Create the release on GitHub<a class="headerlink" href="#create-the-release-on-github" title="Permalink to this headline">¶</a></h2>
<p>On the project’s github page, click the releases tab and then press the
“Draft a new release” button to create a release from the appropriate tag.</p>
</div>
<div class="section" id="announcing-the-release">
<h2>Announcing the release<a class="headerlink" href="#announcing-the-release" title="Permalink to this headline">¶</a></h2>
<p>Send release announcements to:</p>
<ul class="simple">
<li><a class="reference external" href="https://groups.google.com/forum/#!forum/pywavelets">https://groups.google.com/forum/#!forum/pywavelets</a> (<a class="reference external" href="mailto:pywavelets%40googlegroups.com">pywavelets<span>@</span>googlegroups<span>.</span>com</a>)</li>
<li><a class="reference external" href="mailto:python-announce-list%40python.org">python-announce-list<span>@</span>python<span>.</span>org</a></li>
<li><a class="reference external" href="mailto:scipy-user%40scipy.org">scipy-user<span>@</span>scipy<span>.</span>org</a></li>
</ul>
</div>
<div class="section" id="prepare-for-continued-development">
<h2>Prepare for continued development<a class="headerlink" href="#prepare-for-continued-development" title="Permalink to this headline">¶</a></h2>
<p>Increment the version number in setup.py and change ISRELEASED to False.</p>
<p>Prepare new release note files for theupcoming release:</p>
<p><code class="docutils literal"><span class="pre">`</span>
<span class="pre">git</span> <span class="pre">add</span> <span class="pre">doc/release/X.X.X-notes.rst</span>
<span class="pre">git</span> <span class="pre">add</span> <span class="pre">doc/source/release.X.X.X.rst</span>
<span class="pre">`</span></code></p>
<p>And add release.X.X.X to the list in:</p>
<p><code class="docutils literal"><span class="pre">`</span> <span class="pre">doc/source/releasenotes.rst</span> <span class="pre">`</span></code></p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Guidelines for Releasing PyWavelets</a><ul>
<li><a class="reference internal" href="#updating-the-release-notes">updating the release notes</a></li>
<li><a class="reference internal" href="#tag-the-release-and-trigger-the-build-of-windows-wheels">Tag the release and trigger the build of Windows wheels</a></li>
<li><a class="reference internal" href="#create-the-source-distribution">Create the source distribution</a></li>
<li><a class="reference internal" href="#upload-the-release-to-pypi">Upload the release to pypi</a></li>
<li><a class="reference internal" href="#upload-the-documentation-to-pypi">Upload the documentation to pypi</a></li>
<li><a class="reference internal" href="#create-the-release-on-github">Create the release on GitHub</a></li>
<li><a class="reference internal" href="#announcing-the-release">Announcing the release</a></li>
<li><a class="reference internal" href="#prepare-for-continued-development">Prepare for continued development</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="testing.html"
title="previous chapter">Testing</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../resources.html"
title="next chapter">Resources</a></p><div>
<h3>Quick links</h3>
<ul>
<li><a href="https://github.com/PyWavelets/pywt"><img src="../_static/github.png" height="16" width="16" alt="" /> Fork on Github</a></li>
<li><a href="http://groups.google.com/group/pywavelets"><img src="../_static/comments.png" height="16" width="16" alt="" /> Discussion Group</a></li>
<li><a href="http://wavelets.pybytes.com/"><img src="../_static/wave.png" height="16" width="16" alt="" /> Explore Wavelets</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<div id="edit-instructions">
<h3>Edit this document</h3>
<p>
<a href="#" id="toggle-edit-info">
<img src="../_static/page_edit.png" height="16" width="16" alt="" />
The source code of this file is hosted on GitHub. Everyone can
update and fix errors in this document with few clicks -
no downloads needed.
</a>
</p>
<ol id="edit-info" style="display: none;">
<li>
Go to
<i><a href="https://github.com/PyWavelets/pywt/blob/master/doc/source/dev/how_to_release.rst" target="_blank">
Guidelines for Releasing PyWavelets
</a></i> on GitHub.
</li>
<li>
Press <b>Edit this file</b> button.
</li>
<li>
Edit file contents using GitHub's text editor in your web browser
</li>
<li>
Fill in the <b>Commit message</b> text box at the end of the page
telling <i>why</i> you did the changes.
Press <b>Propose file change</b> button next to it when done.
</li>
<li>
On <i>Send a pull request</i> page you don't need to fill in text
anymore. Just press <b>Send pull request</b> button.
</li>
<li>
Your changes are now queued for review under project's
<a href="https://github.com/PyWavelets/pywt/pulls" target="_blank">Pull requests</a> tab
on Github.
</li>
</ol>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<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="../resources.html" title="Resources"
>next</a> |</li>
<li class="right" >
<a href="testing.html" title="Testing"
>previous</a> |</li>
<li><a href="../index.html">Home »</a></li>
<li class="nav-item nav-item-1"><a href="index.html" >Development notes</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2006-2017, <a href="https://groups.google.com/forum/#!forum/pywavelets">The PyWavelets Developers</a>.
Last updated on September 05, 2017.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
|