devdocs/devel/release_guide.html at first_commit · matplotlib/devdocs

History

562 lines (507 loc) · 25.7 KB

Raw

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

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Release Guide — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.0.2.post4416.dev0+g1df513f',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

</map>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="MEP/index.html" title="Matplotlib Enhancement Proposals"

accesskey="N">next</a> |</li>

<a href="coding_guide.html" title="Reviewers guideline"

accesskey="P">previous</a> |</li>

<li><a href="../gallery/index.html">examples</a>| </li>

<li><a href="../tutorials/index.html">tutorials</a>| </li>

<li><a href="../api/pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib Developers’ Guide</a> »</li>

</ul>

</div>

</a>

<br/>

</a>

<br/>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<br/>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Release Guide</a><ul>

<li><a class="reference internal" href="#all-releases">All Releases</a><ul>

<li><a class="reference internal" href="#testing">Testing</a></li>

<li><a class="reference internal" href="#github-stats">GitHub Stats</a></li>

<li><a class="reference internal" href="#check-docs">Check Docs</a></li>

<li><a class="reference internal" href="#create-release-commit-and-tag">Create release commit and tag</a></li>

<li><a class="reference internal" href="#release-management-doi">Release Management / DOI</a></li>

<li><a class="reference internal" href="#building-binaries">Building binaries</a></li>

<li><a class="reference internal" href="#make-distribution-and-upload-to-pypi-sf">make distribution and upload to pypi / SF</a></li>

<li><a class="reference internal" href="#build-and-deploy-documentation">Build and Deploy Documentation</a></li>

<li><a class="reference internal" href="#announcing">Announcing</a></li>

</ul>

</li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">The Matplotlib Developers’ Guide</a><ul>

<li>Previous: <a href="coding_guide.html" title="previous chapter">Reviewers guideline</a></li>

<li>Next: <a href="MEP/index.html" title="next chapter">Matplotlib Enhancement Proposals</a></li>

</ul></li>

</ul>

</div>

<li><a href="../_sources/devel/release_guide.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<span id="id1"></span><h1>Release Guide<a class="headerlink" href="#release-guide" title="Permalink to this headline">¶</a></h1>

<p>A guide for developers who are doing a matplotlib release.</p>

<h2>All Releases<a class="headerlink" href="#all-releases" title="Permalink to this headline">¶</a></h2>

<span id="release-testing"></span><h3>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>

<p>We use <a class="reference external" href="https://travis-ci.org/matplotlib/matplotlib">travis-ci</a> for

continuous integration. When preparing for a release, the final

tagged commit should be tested locally before it is uploaded:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>python tests.py --processes<span class="o">=</span><span class="m">8</span> --process-timeout<span class="o">=</span>300

</pre></div>

</div>

<p>In addition the following two tests should be run and manually inspected:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>python unit/memleak_hawaii3.py

<span class="nb">pushd</span> examples/tests/

python backend_driver.py

</pre></div>

</div>

<span id="release-ghstats"></span><h3>GitHub Stats<a class="headerlink" href="#github-stats" title="Permalink to this headline">¶</a></h3>

<p>We automatically extract GitHub issue, PRs, and authors from GitHub via the API:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>python tools/github_stats.py --since-tag <span class="nv">$TAG</span> --project <span class="s1">'matplotlib/matplotlib'</span> --links > doc/users/github_stats.rst

</pre></div>

</div>

<p>Review and commit changes. Some issue/PR titles may not be valid rst (the most common issue is

<code class="docutils literal"><span class="pre">*</span></code> which is interpreted as unclosed markup).</p>

</div>

<span id="release-chkdocs"></span><h3>Check Docs<a class="headerlink" href="#check-docs" title="Permalink to this headline">¶</a></h3>

<p>Before tagging, make sure that the docs build cleanly</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nb">pushd</span> doc

python make.py html latex -n 16

</pre></div>

</div>

<p>After the docs are built, check that all of the links, internal and external, are still

valid. We use <code class="docutils literal"><span class="pre">linkchecker</span></code> for this, which has not been ported to python3 yet. You will

need to create a python2 environment with <code class="docutils literal"><span class="pre">requests==2.9.0</span></code> and linkchecker</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>conda create -p /tmp/lnkchk <span class="nv">python</span><span class="o">=</span><span class="m">2</span> <span class="nv">requests</span><span class="o">==</span>2.9.0

<span class="nb">source</span> activate /tmp/lnkchk

pip install linkchecker

<span class="nb">pushd</span> doc/build/html

linkchecker index.html --check-extern

</pre></div>

</div>

<p>Address any issues which may arise. The internal links are checked on travis, this should only

flag failed external links.</p>

</div>

<span id="release-tag"></span><h3>Create release commit and tag<a class="headerlink" href="#create-release-commit-and-tag" title="Permalink to this headline">¶</a></h3>

<p>To create the tag, first create an empty commit with a very terse set of the release notes

in the commit message</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git commit --allow-empty

</pre></div>

</div>

<p>and then create a signed, annotated tag with the same text in the body

message</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git tag -a -s v2.0.0

</pre></div>

</div>

<p>which will prompt you for your gpg key password and an annotation.

For pre releases it is important to follow <span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0440"><strong>PEP 440</strong></a> so that the

build artifacts will sort correctly in pypi. Finally, push the tag to GitHub</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git push -t DANGER v2.0.0

</pre></div>

</div>

<p>Congratulations, the scariest part is done!</p>

<p>To prevent issues with any down-stream builders which download the

tarball from GitHub it is important to move all branches away from the commit

with the tag <a class="footnote-reference" href="#id3" id="id2">[1]</a>:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git commit --allow-empty

git push DANGER master

</pre></div>

</div>

<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td><p class="first">The tarball that is provided by GitHub is produced using <a class="reference external" href="https://git-scm.com/docs/git-archive">git

archive</a>. We use

<a class="reference external" href="https://github.com/warner/python-versioneer">versioneer</a>

which uses a format string in

<code class="file docutils literal"><span class="pre">lib/matplotlib/_version.py</span></code> to have <code class="docutils literal"><span class="pre">git</span></code> insert a

list of references to exported commit (see

<code class="file docutils literal"><span class="pre">.gitattributes</span></code> for the configuration). This string is

then used by <code class="docutils literal"><span class="pre">versioneer</span></code> to produce the correct version,

based on the git tag, when users install from the tarball.

However, if there is a branch pointed at the tagged commit,

then the branch name will also be included in the tarball.

When the branch eventually moves, anyone how checked the hash

of the tarball before the branch moved will have an incorrect

hash.</p>

<p>To generate the file that GitHub does use</p>

<div class="last highlight-bash"><div class="highlight"><pre><span></span>git archive v2.0.0 -o matplotlib-2.0.0.tar.gz --prefix<span class="o">=</span>matplotlib-2.0.0/

</pre></div>

</div>

</td></tr>

</tbody>

</table>

<p>If this is a final release, also create a ‘doc’ branch (this is not

done for pre-releases):</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git branch v2.0.0-doc

git push DANGER v2.0.0-doc

</pre></div>

</div>

<p>and if this is a major or minor release, also create a bug-fix branch (a

micro release will be cut off of this branch):</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git branch v2.0.x

git push DANGER v2.0.x

</pre></div>

</div>

<span id="release-doi"></span><h3>Release Management / DOI<a class="headerlink" href="#release-management-doi" title="Permalink to this headline">¶</a></h3>

<p>Via the GitHub UI (chase down link), turn the newly pushed tag into a

release. If this is a pre-release remember to mark it as such.</p>

<p>For final releases also get a DOI from <a class="reference external" href="https://zenodo.org/">zenodo</a> and edit <code class="file docutils literal"><span class="pre">doc/_templates/citing.html</span></code>

with DOI link and commit to the VER-doc branch and push to GitHub</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git checkout v2.0.0-doc

emacs doc/_templates/citing.html

git push DANGER v2.0.0-doc:v2.0.0-doc

</pre></div>

</div>

<span id="release-bld-bin"></span><h3>Building binaries<a class="headerlink" href="#building-binaries" title="Permalink to this headline">¶</a></h3>

<p>We distribute mac, windows, and many linux wheels as well as a source

tarball via pypi. Before uploading anything, contact the various

builders. Mac and manylinux wheels are built on travis . You need to

edit the <code class="file docutils literal"><span class="pre">.travis.yml</span></code> file and push to master of <a class="reference external" href="https://github.com/MacPython/matplotlib-wheels">the build

project</a>.</p>

<p>Update the <code class="docutils literal"><span class="pre">master</span></code> branch (for pre-releases the <code class="docutils literal"><span class="pre">devel</span></code> branch)

of the <a class="reference external" href="https://github.com/conda-forge/matplotlib-feedstock">conda-forge feedstock</a> via pull request.</p>

<p>If this is a final release the following downstream packagers should be contacted:</p>

<li>Debian</li>

<li>Fedora</li>

<li>Gentoo</li>

<li>Macports</li>

<li>Homebrew</li>

<li>Christoph Gohlke</li>

<li>Continuum</li>

<li>Enthought</li>

</ul>

<p>This can be done ahead of collecting all of the binaries and uploading to pypi.</p>

</div>

<span id="release-upload-bin"></span><h3>make distribution and upload to pypi / SF<a class="headerlink" href="#make-distribution-and-upload-to-pypi-sf" title="Permalink to this headline">¶</a></h3>

<p>Once you have collected all of the wheels, generate the tarball</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git checkout v2.0.0

git clean -xfd

python setup.py sdist

</pre></div>

</div>

<p>and copy all of the wheels into <code class="file docutils literal"><span class="pre">dist</span></code> directory. You should use

<code class="docutils literal"><span class="pre">twine</span></code> to upload all of the files to pypi</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>twine upload -s dist/matplotlib*tar.gz

twine upload dist/*whl

</pre></div>

</div>

<p>Congratulations, you have now done the second scariest part!</p>

<p>Additionally, for a final release, upload all of the files to sourceforge.</p>

</div>

<span id="release-docs"></span><h3>Build and Deploy Documentation<a class="headerlink" href="#build-and-deploy-documentation" title="Permalink to this headline">¶</a></h3>

<p>To build the documentation you must have the tagged version installed, but

build the docs from the <code class="docutils literal"><span class="pre">ver-doc</span></code> branch. An easy way to arrange this is:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>pip install matplotlib

pip install -r doc-requirements.txt

git checkout v2.0.0-doc

git clean -xfd

<span class="nb">cd</span> doc

python make.py html latex -n 16

</pre></div>

</div>

<p>which will build both the html and pdf version of the documentation.</p>

<p>The built documentation exists in the <a class="reference external" href="https://github.com/matplotlib/matplotlib.github.com/">matplotlib.github.com</a> repository.

Pushing changes to master automatically updates the website.</p>

<p>The documentation is organized by version. At the root of the tree is

always the documentation for the latest stable release. Under that,

there are directories containing the documentation for older versions.

The documentation for current master are built on travis and push to

the <a class="reference external" href="https://github.com/matplotlib/devdocs/">devdocs</a> repository.

These are available at <a class="reference external" href="http://matplotlib.org/devdocs">matplotlib.org/devdocs</a>.</p>

<p>Assuming you have this repository checked out in the same directory as

matplotlib</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="nb">cd</span> ../matplotlib.github.com

mkdir 2.0.0

rsync -a ../matplotlib/doc/build/html/* 2.0.0

cp ../matplotlib/doc/build/latex/Matplotlib.pdf 2.0.0

</pre></div>

</div>

<p>which will copy the built docs over. If this is a final release, also

replace the top-level docs</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>rsync -a 2.0.0/* ./

</pre></div>

</div>

<p>You will need to manually edit <code class="file docutils literal"><span class="pre">versions.html</span></code> to show the last

3 tagged versions. Now commit and push everything to GitHub</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git add *

git commit -a -m <span class="s1">'Updating docs for v2.0.0'</span>

git push DANGER master

</pre></div>

</div>

<p>Congratulations you have now done the third scariest part!</p>

<p>It typically takes about 5-10 minutes for GitHub to process the push

and update the live web page (remember to clear your browser cache).</p>

</div>

<h3>Announcing<a class="headerlink" href="#announcing" title="Permalink to this headline">¶</a></h3>

<p>The final step is to announce the release to the world. A short

version of the release notes along with acknowledgments should be sent to</p>

<li><a class="reference external" href="mailto:matplotlib-user%40python.org">matplotlib-user<span>@</span>python<span>.</span>org</a></li>

<li><a class="reference external" href="mailto:matplotlib-devel%40python.org">matplotlib-devel<span>@</span>python<span>.</span>org</a></li>

<li><a class="reference external" href="mailto:matplotlib-announce%40python.org">matplotlib-announce<span>@</span>python<span>.</span>org</a></li>

</ul>

<p>For final releases announcements should also be sent to the

numpy/scipy/jupyter mailing lists and python-announce.</p>

<p>In addition, announcements should be made on social networks (twitter,

g+, FB). For major release, <a class="reference external" href="http://www.numfocus.org/">NumFOCUS</a>

should be contacted for inclusion in their newsletter and maybe to

have something posted on their blog.</p>

</div>

</div>

Last updated on Jul 16, 2017.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

release_guide.html

Latest commit

History

release_guide.html

File metadata and controls