{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathrelease_guide.html
More file actions
1046 lines (845 loc) · 59.9 KB
/
Copy pathrelease_guide.html
File metadata and controls
1046 lines (845 loc) · 59.9 KB
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
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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Release guide — Matplotlib 3.8.3 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v=86e00652" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v=c5620d72" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
<script src="../_static/documentation_options.js?v=db1eed5b"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=ccdb6887"></script>
<script src="../_static/design-tabs.js?v=36754332"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'devel/release_guide';</script>
<script>
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.8.3-2-g6175ebf59d';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.8.3';
</script>
<link rel="canonical" href="https://matplotlib.org/stable/devel/release_guide.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.8.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Community management guide" href="communication_guide.html" />
<link rel="prev" title="Documentation style guide" href="style_guide.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar">
<div class="bd-header__inner bd-page-width">
<label class="sidebar-toggle primary-toggle" for="__primary">
<span class="fa-solid fa-bars"></span>
</label>
<div class="navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="https://matplotlib.org/stable/">
<img src="../_static/logo_light.svg" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="../_static/logo_dark.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script></div>
<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links navbar-nav"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
</div>
<label class="sidebar-toggle secondary-toggle" for="__secondary">
<span class="fa-solid fa-outdent"></span>
</label>
</div>
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script></div>
<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links navbar-nav"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item"><nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="development_setup.html">Setting up Matplotlib for development</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../users/installing/dependencies.html">Dependencies</a></li>
</ul>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="development_workflow.html">Development workflow</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="coding_guide.html">Pull request guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="document.html">Write documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="style_guide.html">Documentation style guide</a></li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Release guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="communication_guide.html">Community management guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="min_dep_policy.html">Dependency version policy</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="MEP/index.html">Matplotlib Enhancement Proposals</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="MEP/template.html">MEP Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP08.html">MEP8: PEP8</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP09.html">MEP9: Global interaction manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP10.html">MEP10: Docstring consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP11.html">MEP11: Third-party dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP12.html">MEP12: Improve Gallery and Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP13.html">MEP13: Use properties for Artists</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP14.html">MEP14: Text handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP15.html">MEP15: Fix axis autoscaling when limits are specified for one axis only</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP19.html">MEP19: Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP21.html">MEP21: color and cm refactor</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP22.html">MEP22: Toolbar rewrite</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP23.html">MEP23: Multiple Figures per GUI window</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP24.html">MEP24: Negative radius in polar plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP25.html">MEP25: Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP26.html">MEP26: Artist styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP27.html">MEP27: Decouple pyplot from backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP29.html">MEP29: Text light markup</a></li>
</ul>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="triage.html">Bug triaging and issue curation</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">Licenses</a></li>
<li class="toctree-l1"><a class="reference internal" href="color_changes.html">Default color changes</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumbs">
<ul class="bd-breadcrumbs" role="navigation" aria-label="Breadcrumb">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">Contribute</a></li>
<li class="breadcrumb-item active" aria-current="page">Release guide</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article" role="main">
<section id="release-guide">
<span id="id1"></span><h1>Release guide<a class="headerlink" href="#release-guide" title="Link to this heading">#</a></h1>
<div class="admonition-this-document-is-only-relevant-for-matplotlib-release-managers admonition">
<p class="admonition-title">This document is only relevant for Matplotlib release managers.</p>
<p>A guide for developers who are doing a Matplotlib release.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This assumes that a read-only remote for the canonical repository is
<code class="docutils literal notranslate"><span class="pre">remote</span></code> and a read/write remote is <code class="docutils literal notranslate"><span class="pre">DANGER</span></code></p>
</div>
<section id="making-the-release-branch">
<span id="release-feature-freeze"></span><h2>Making the release branch<a class="headerlink" href="#making-the-release-branch" title="Link to this heading">#</a></h2>
<p>When a new minor release (vX.Y.0) is approaching, a new release branch must be made.
When precisely this should happen is up to the release manager, but this point is where
most new features intended for the minor release are merged and you are entering a
feature freeze (i.e. newly implemented features will be going into vX.Y+1).
This does not necessarily mean that no further changes will be made prior to release,
just that those changes will be made using the backport system.</p>
<p>For an upcoming <code class="docutils literal notranslate"><span class="pre">v3.7.0</span></code> release, first create the branch:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>switch<span class="w"> </span>main
git<span class="w"> </span>pull
git<span class="w"> </span>switch<span class="w"> </span>-c<span class="w"> </span>v3.7.x
git<span class="w"> </span>push<span class="w"> </span>DANGER<span class="w"> </span>v3.7.x
</pre></div>
</div>
<p>Update the <code class="docutils literal notranslate"><span class="pre">v3.7.0</span></code> milestone so that the description reads:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>New<span class="w"> </span>features<span class="w"> </span>and<span class="w"> </span>API<span class="w"> </span>changes
on-merge:<span class="w"> </span>backport<span class="w"> </span>to<span class="w"> </span>v3.7.x
</pre></div>
</div>
<p>Micro versions should instead read:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Bugfixes<span class="w"> </span>and<span class="w"> </span>docstring<span class="w"> </span>changes
on-merge:<span class="w"> </span>backport<span class="w"> </span>to<span class="w"> </span>v3.7.x
</pre></div>
</div>
<p>Check all active milestones for consistency. Older milestones should also backport
to higher minor versions (e.g. <code class="docutils literal notranslate"><span class="pre">v3.6.3</span></code> and <code class="docutils literal notranslate"><span class="pre">v3.6-doc</span></code> should backport to both
<code class="docutils literal notranslate"><span class="pre">v3.6.x</span></code> and <code class="docutils literal notranslate"><span class="pre">v3.7.x</span></code> once the <code class="docutils literal notranslate"><span class="pre">v3.7.x</span></code> branch exists and while PR backports are
still targeting <code class="docutils literal notranslate"><span class="pre">v3.6.x</span></code>)</p>
<p>Create the milestone for the next-next minor release (i.e. <code class="docutils literal notranslate"><span class="pre">v3.9.0</span></code>, as <code class="docutils literal notranslate"><span class="pre">v3.8.0</span></code>
should already exist). While most active items should go in the next minor release,
this milestone can help with longer term planning, especially around deprecation
cycles.</p>
</section>
<section id="testing">
<span id="release-testing"></span><h2>Testing<a class="headerlink" href="#testing" title="Link to this heading">#</a></h2>
<p>We use <a class="reference external" href="https://github.com/matplotlib/matplotlib/actions">GitHub Actions</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 notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>-n<span class="w"> </span><span class="m">8</span><span class="w"> </span>.
</pre></div>
</div>
<p>In addition the following test should be run and manually inspected:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>tools/memleak.py<span class="w"> </span>agg<span class="w"> </span><span class="m">1000</span><span class="w"> </span>agg.pdf
</pre></div>
</div>
<p>Run the User Acceptance Tests for the NBAgg and ipympl backends:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>jupyter<span class="w"> </span>notebook<span class="w"> </span>lib/matplotlib/backends/web_backend/nbagg_uat.ipynb
</pre></div>
</div>
<p>For ipympl, restart the kernel, add a cell for <code class="docutils literal notranslate"><span class="pre">%matplotlib</span> <span class="pre">widget</span></code> and do
not run the cell with <code class="docutils literal notranslate"><span class="pre">matplotlib.use('nbagg')</span></code>. Tests which check
<code class="docutils literal notranslate"><span class="pre">connection_info</span></code>, use <code class="docutils literal notranslate"><span class="pre">reshow</span></code>, or test the OO interface are not expected
to work for <code class="docutils literal notranslate"><span class="pre">ipympl</span></code>.</p>
</section>
<section id="github-statistics">
<span id="release-ghstats"></span><h2>GitHub statistics<a class="headerlink" href="#github-statistics" title="Link to this heading">#</a></h2>
<p>We automatically extract GitHub issue, PRs, and authors from GitHub via the API. To
prepare this list:</p>
<ol class="arabic">
<li><p>Archive the existing GitHub statistics page.</p>
<ol class="loweralpha simple">
<li><p>Copy the current <code class="file docutils literal notranslate"><span class="pre">doc/users/github_stats.rst</span></code> to
<code class="file docutils literal notranslate"><span class="pre">doc/users/prev_whats_new/github_stats_</span><em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y</span></em><span class="pre">.</span><em><span class="pre">Z</span></em><span class="pre">.rst</span></code>.</p></li>
<li><p>Change the link target at the top of the file.</p></li>
<li><p>Remove the "Previous GitHub Stats" section at the end.</p></li>
</ol>
<p>For example, when updating from v3.7.0 to v3.7.1:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cp<span class="w"> </span>doc/users/github_stats.rst<span class="w"> </span>doc/users/prev_whats_new/github_stats_3.7.0.rst
<span class="nv">$EDITOR</span><span class="w"> </span>doc/users/prev_whats_new/github_stats_3.7.0.rst
<span class="c1"># Change contents as noted above.</span>
git<span class="w"> </span>add<span class="w"> </span>doc/users/prev_whats_new/github_stats_3.7.0.rst
</pre></div>
</div>
</li>
<li><p>Re-generate the updated stats:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>tools/github_stats.py<span class="w"> </span>--since-tag<span class="w"> </span>v3.7.0<span class="w"> </span>--milestone<span class="o">=</span>v3.7.1<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--project<span class="w"> </span><span class="s1">'matplotlib/matplotlib'</span><span class="w"> </span>--links<span class="w"> </span>><span class="w"> </span>doc/users/github_stats.rst
</pre></div>
</div>
</li>
<li><p>Review and commit changes. Some issue/PR titles may not be valid reST (the most
common issue is <code class="docutils literal notranslate"><span class="pre">*</span></code> which is interpreted as unclosed markup).</p></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Make sure you authenticate against the GitHub API. If you do not, you will get
blocked by GitHub for going over the API rate limits. You can authenticate in one of
two ways:</p>
<ul class="simple">
<li><p>using the <code class="docutils literal notranslate"><span class="pre">keyring</span></code> package; <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">keyring</span></code> and then when
running the stats script, you will be prompted for user name and password,
that will be stored in your system keyring, or,</p></li>
<li><p>using a personal access token; generate a new token <a class="reference external" href="https://github.com/settings/tokens">on this GitHub page</a> with the <code class="docutils literal notranslate"><span class="pre">repo:public_repo</span></code>
scope and place the token in <code class="file docutils literal notranslate"><span class="pre">~/.ghoauth</span></code>.</p></li>
</ul>
</div>
</section>
<section id="update-and-validate-the-docs">
<span id="release-chkdocs"></span><h2>Update and validate the docs<a class="headerlink" href="#update-and-validate-the-docs" title="Link to this heading">#</a></h2>
<section id="merge-doc-branch">
<h3>Merge <code class="docutils literal notranslate"><span class="pre">*-doc</span></code> branch<a class="headerlink" href="#merge-doc-branch" title="Link to this heading">#</a></h3>
<p>Merge the most recent 'doc' branch (e.g., <code class="docutils literal notranslate"><span class="pre">v3.7.0-doc</span></code>) into the branch you
are going to tag on and delete the doc branch on GitHub.</p>
</section>
<section id="update-supported-versions-in-security-policy">
<h3>Update supported versions in Security Policy<a class="headerlink" href="#update-supported-versions-in-security-policy" title="Link to this heading">#</a></h3>
<p>When making major or minor releases, update the supported versions in the Security
Policy in <code class="file docutils literal notranslate"><span class="pre">SECURITY.md</span></code>.</p>
<p>For minor version release update the table in <code class="file docutils literal notranslate"><span class="pre">SECURITY.md</span></code> to specify that the
two most recent minor releases in the current major version series are supported.</p>
<p>For a major version release update the table in <code class="file docutils literal notranslate"><span class="pre">SECURITY.md</span></code> to specify that the
last minor version in the previous major version series is still supported. Dropping
support for the last version of a major version series will be handled on an ad-hoc
basis.</p>
</section>
<section id="update-release-notes">
<h3>Update release notes<a class="headerlink" href="#update-release-notes" title="Link to this heading">#</a></h3>
<section id="what-s-new">
<h4>What's new<a class="headerlink" href="#what-s-new" title="Link to this heading">#</a></h4>
<p><em>Only needed for major and minor releases. Bugfix releases should not have new
features.</em></p>
<p>Merge the contents of all the files in <code class="file docutils literal notranslate"><span class="pre">doc/users/next_whats_new/</span></code> into a single
file <code class="file docutils literal notranslate"><span class="pre">doc/users/prev_whats_new/whats_new_</span><em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y</span></em><span class="pre">.0.rst</span></code> and delete the individual
files.</p>
</section>
<section id="api-changes">
<h4>API changes<a class="headerlink" href="#api-changes" title="Link to this heading">#</a></h4>
<p><em>Primarily needed for major and minor releases. We may sometimes have API
changes in bugfix releases.</em></p>
<p>Merge the contents of all the files in <code class="file docutils literal notranslate"><span class="pre">doc/api/next_api_changes/</span></code> into a single
file <code class="file docutils literal notranslate"><span class="pre">doc/api/prev_api_changes/api_changes_</span><em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y</span></em><span class="pre">.</span><em><span class="pre">Z</span></em><span class="pre">.rst</span></code> and delete the
individual files.</p>
</section>
<section id="release-notes-toc">
<h4>Release notes TOC<a class="headerlink" href="#release-notes-toc" title="Link to this heading">#</a></h4>
<p>Update <code class="file docutils literal notranslate"><span class="pre">doc/users/release_notes.rst</span></code>:</p>
<ul>
<li><p>For major and minor releases add a new section</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="gh">X.Y</span>
<span class="gh">===</span>
<span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
<span class="nc">:maxdepth:</span> 1
prev_whats_new/whats_new_X.Y.0.rst
<span class="cp"> ../api/prev_api_changes/api_changes_X.Y.0.rst</span>
<span class="cp"> prev_whats_new/github_stats_X.Y.0.rst</span>
</pre></div>
</div>
</li>
<li><p>For bugfix releases add the GitHub stats and (if present) the API changes to
the existing X.Y section</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="cp">../api/prev_api_changes/api_changes_X.Y.Z.rst</span>
prev_whats_new/github_stats_X.Y.Z.rst
</pre></div>
</div>
</li>
</ul>
</section>
<section id="update-version-switcher">
<h4>Update version switcher<a class="headerlink" href="#update-version-switcher" title="Link to this heading">#</a></h4>
<p>Update <code class="docutils literal notranslate"><span class="pre">doc/_static/switcher.json</span></code>:</p>
<ul class="simple">
<li><p>If a bugfix release, <code class="samp docutils literal notranslate"><em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y</span></em><span class="pre">.</span><em><span class="pre">Z</span></em></code>, no changes are needed.</p></li>
<li><p>If a major release, <code class="samp docutils literal notranslate"><em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y</span></em><span class="pre">.0</span></code>, change the name of <code class="samp docutils literal notranslate"><span class="pre">name:</span> <em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y+1</span></em>
<span class="pre">(dev)</span></code> and <code class="samp docutils literal notranslate"><span class="pre">name:</span> <em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y</span></em> <span class="pre">(stable)</span></code> as well as adding a new version for the
previous stable (<code class="samp docutils literal notranslate"><span class="pre">name:</span> <em><span class="pre">X</span></em><span class="pre">.</span><em><span class="pre">Y-1</span></em></code>).</p></li>
</ul>
</section>
</section>
<section id="verify-that-docs-build">
<h3>Verify that docs build<a class="headerlink" href="#verify-that-docs-build" title="Link to this heading">#</a></h3>
<p>Finally, make sure that the docs build cleanly:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>-Cdoc<span class="w"> </span><span class="nv">O</span><span class="o">=</span>-j<span class="k">$(</span>nproc<span class="k">)</span><span class="w"> </span>html<span class="w"> </span>latexpdf
</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 notranslate"><span class="pre">linkchecker</span></code> for this:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>linkchecker
<span class="nb">pushd</span><span class="w"> </span>doc/build/html
linkchecker<span class="w"> </span>index.html<span class="w"> </span>--check-extern
<span class="nb">popd</span>
</pre></div>
</div>
<p>Address any issues which may arise. The internal links are checked on Circle CI, so this
should only flag failed external links.</p>
</section>
</section>
<section id="create-release-commit-and-tag">
<span id="release-tag"></span><h2>Create release commit and tag<a class="headerlink" href="#create-release-commit-and-tag" title="Link to this heading">#</a></h2>
<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 notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>--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 notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>tag<span class="w"> </span>-a<span class="w"> </span>-s<span class="w"> </span>v3.7.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://peps.python.org/pep-0440/"><strong>PEP 440</strong></a> so that the build artifacts will sort correctly in
PyPI.</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 brackets" href="#id3" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>commit<span class="w"> </span>--allow-empty
</pre></div>
</div>
<p>Finally, push the tag to GitHub:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>push<span class="w"> </span>DANGER<span class="w"> </span>v3.7.x<span class="w"> </span>v3.7.0
</pre></div>
</div>
<p>Congratulations, the scariest part is done!
This assumes the release branch has already been made.
Usually this is done at the time of feature freeze for a minor release (which often
coincides with the last patch release of the previous minor version)</p>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id3" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id2">1</a><span class="fn-bracket">]</span></span>
<p>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/pypa/setuptools_scm">setuptools_scm</a> which uses a format string in
<code class="file docutils literal notranslate"><span class="pre">lib/matplotlib/_version.py</span></code> to have <code class="docutils literal notranslate"><span class="pre">git</span></code> insert a
list of references to exported commit (see
<code class="file docutils literal notranslate"><span class="pre">.gitattributes</span></code> for the configuration). This string is
then used by <code class="docutils literal notranslate"><span class="pre">setuptools_scm</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 who 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="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>archive<span class="w"> </span>v3.7.0<span class="w"> </span>-o<span class="w"> </span>matplotlib-3.7.0.tar.gz<span class="w"> </span>--prefix<span class="o">=</span>matplotlib-3.7.0/
</pre></div>
</div>
</aside>
</aside>
<p>If this is a final release, also create a 'doc' branch (this is not
done for pre-releases):</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>branch<span class="w"> </span>v3.7.0-doc
git<span class="w"> </span>push<span class="w"> </span>DANGER<span class="w"> </span>v3.7.0-doc
</pre></div>
</div>
<p>Update (or create) the <code class="docutils literal notranslate"><span class="pre">v3.7-doc</span></code> milestone.
The description should include the instruction for meeseeksmachine to backport changes
with the <code class="docutils literal notranslate"><span class="pre">v3.7-doc</span></code> milestone to both the <code class="docutils literal notranslate"><span class="pre">v3.7.x</span></code> branch and the <code class="docutils literal notranslate"><span class="pre">v3.7.0-doc</span></code> branch:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Documentation<span class="w"> </span>changes<span class="w"> </span><span class="o">(</span>.rst<span class="w"> </span>files<span class="w"> </span>and<span class="w"> </span>examples<span class="o">)</span>
on-merge:<span class="w"> </span>backport<span class="w"> </span>to<span class="w"> </span>v3.7.x
on-merge:<span class="w"> </span>backport<span class="w"> </span>to<span class="w"> </span>v3.7.0-doc
</pre></div>
</div>
<p>Check all active milestones for consistency. Older doc milestones should also backport to
higher minor versions (e.g. <code class="docutils literal notranslate"><span class="pre">v3.6-doc</span></code> should backport to both <code class="docutils literal notranslate"><span class="pre">v3.6.x</span></code> and <code class="docutils literal notranslate"><span class="pre">v3.7.x</span></code>
if the <code class="docutils literal notranslate"><span class="pre">v3.7.x</span></code> branch exists)</p>
</section>
<section id="release-management-doi">
<span id="release-doi"></span><h2>Release management / DOI<a class="headerlink" href="#release-management-doi" title="Link to this heading">#</a></h2>
<p>Via the <a class="reference external" href="https://github.com/matplotlib/matplotlib/releases">GitHub UI</a>, 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 the DOI from <a class="reference external" href="https://zenodo.org/">Zenodo</a> (which will
automatically produce one once the tag is pushed). Add the DOI post-fix and version to
the dictionary in <code class="file docutils literal notranslate"><span class="pre">tools/cache_zenodo_svg.py</span></code> and run the script.</p>
<p>This will download the new SVG to <code class="file docutils literal notranslate"><span class="pre">doc/_static/zenodo_cache/</span><em><span class="pre">postfix</span></em><span class="pre">.svg</span></code> and
edit <code class="file docutils literal notranslate"><span class="pre">doc/users/project/citing.rst</span></code>. Commit the new SVG, the change to
<code class="file docutils literal notranslate"><span class="pre">tools/cache_zenodo_svg.py</span></code>, and the changes to <code class="file docutils literal notranslate"><span class="pre">doc/users/project/citing.rst</span></code>
to the VER-doc branch and push to GitHub.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>v3.7.0-doc
<span class="nv">$EDITOR</span><span class="w"> </span>tools/cache_zenodo_svg.py
python<span class="w"> </span>tools/cache_zenodo_svg.py
git<span class="w"> </span>commit<span class="w"> </span>-a
git<span class="w"> </span>push<span class="w"> </span>DANGER<span class="w"> </span>v3.7.0-doc:v3.7.0-doc
</pre></div>
</div>
</section>
<section id="building-binaries">
<span id="release-bld-bin"></span><h2>Building binaries<a class="headerlink" href="#building-binaries" title="Link to this heading">#</a></h2>
<p>We distribute macOS, Windows, and many Linux wheels as well as a source tarball via
PyPI. Most builders should trigger automatically once the tag is pushed to GitHub:</p>
<ul class="simple">
<li><p>Windows, macOS and manylinux wheels are built on GitHub Actions. Builds are triggered
by the GitHub Action defined in <code class="file docutils literal notranslate"><span class="pre">.github/workflows/cibuildwheel.yml</span></code>, and wheels
will be available as artifacts of the build.</p></li>
<li><p>The auto-tick bot should open a pull request into the <a class="reference external" href="https://github.com/conda-forge/matplotlib-feedstock">conda-forge feedstock</a>. Review and merge (if you
have the power to).</p></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Because this is automated, it is extremely important to bump all branches away from
the tag as discussed in <a class="reference internal" href="#release-tag"><span class="std std-ref">Create release commit and tag</span></a>.</p>
</div>
</section>
<section id="make-distribution-and-upload-to-pypi">
<span id="release-upload-bin"></span><h2>Make distribution and upload to PyPI<a class="headerlink" href="#make-distribution-and-upload-to-pypi" title="Link to this heading">#</a></h2>
<p>Once you have collected all of the wheels (expect this to take a few hours), generate
the tarball:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>v3.7.0
git<span class="w"> </span>clean<span class="w"> </span>-xfd
python<span class="w"> </span>-m<span class="w"> </span>build<span class="w"> </span>--sdist
</pre></div>
</div>
<p>and copy all of the wheels into <code class="file docutils literal notranslate"><span class="pre">dist</span></code> directory. First, check that the dist files
are OK:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>twine<span class="w"> </span>check<span class="w"> </span>dist/*
</pre></div>
</div>
<p>and then use <code class="docutils literal notranslate"><span class="pre">twine</span></code> to upload all of the files to PyPI</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>twine<span class="w"> </span>upload<span class="w"> </span>-s<span class="w"> </span>dist/matplotlib*tar.gz
twine<span class="w"> </span>upload<span class="w"> </span>dist/*whl
</pre></div>
</div>
<p>Congratulations, you have now done the second scariest part!</p>
</section>
<section id="build-and-deploy-documentation">
<span id="release-docs"></span><h2>Build and deploy documentation<a class="headerlink" href="#build-and-deploy-documentation" title="Link to this heading">#</a></h2>
<p>To build the documentation you must have the tagged version installed, but
build the docs from the <code class="docutils literal notranslate"><span class="pre">ver-doc</span></code> branch. An easy way to arrange this is:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>matplotlib
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements/doc/doc-requirements.txt
git<span class="w"> </span>checkout<span class="w"> </span>v3.7.0-doc
git<span class="w"> </span>clean<span class="w"> </span>-xfd
make<span class="w"> </span>-Cdoc<span class="w"> </span><span class="nv">O</span><span class="o">=</span><span class="s2">"-t release -j</span><span class="k">$(</span>nproc<span class="k">)</span><span class="s2">"</span><span class="w"> </span>html<span class="w"> </span>latexpdf<span class="w"> </span><span class="nv">LATEXMKOPTS</span><span class="o">=</span><span class="s2">"-silent -f"</span>
</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 main automatically updates the website.</p>
<p>The documentation is organized in subdirectories by version. The latest stable release
is symlinked from the <code class="file docutils literal notranslate"><span class="pre">stable</span></code> directory. The documentation for current main is
built on Circle CI and pushed to the <a class="reference external" href="https://github.com/matplotlib/devdocs/">devdocs</a> repository. These are available at
<a class="reference external" href="https://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 notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>../matplotlib.github.com
cp<span class="w"> </span>-a<span class="w"> </span>../matplotlib/doc/build/html<span class="w"> </span><span class="m">3</span>.7.0
rm<span class="w"> </span><span class="m">3</span>.7.0/.buildinfo
cp<span class="w"> </span>../matplotlib/doc/build/latex/Matplotlib.pdf<span class="w"> </span><span class="m">3</span>.7.0
</pre></div>
</div>
<p>which will copy the built docs over. If this is a final release, link the
<code class="docutils literal notranslate"><span class="pre">stable</span></code> subdirectory to the newest version:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rm<span class="w"> </span>stable
ln<span class="w"> </span>-s<span class="w"> </span><span class="m">3</span>.7.0<span class="w"> </span>stable
</pre></div>
</div>
<p>You will need to manually edit <code class="file docutils literal notranslate"><span class="pre">versions.html</span></code> to show the released version.
You will also need to edit <code class="file docutils literal notranslate"><span class="pre">sitemap.xml</span></code> to include
the newly released version. Now commit and push everything to GitHub</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>add<span class="w"> </span>*
git<span class="w"> </span>commit<span class="w"> </span>-a<span class="w"> </span>-m<span class="w"> </span><span class="s1">'Updating docs for v3.7.0'</span>
git<span class="w"> </span>push<span class="w"> </span>DANGER<span class="w"> </span>main
</pre></div>
</div>
<p>Congratulations you have now done the third scariest part!</p>
<p>If you have access, clear the CloudFlare caches.</p>
<p>It typically takes about 5-10 minutes for the website to process the push and update the
live web page (remember to clear your browser cache).</p>
</section>
<section id="merge-up-changes-to-main">
<span id="release-merge-up"></span><h2>Merge up changes to main<a class="headerlink" href="#merge-up-changes-to-main" title="Link to this heading">#</a></h2>
<p>After a release is done, the changes from the release branch should be merged into the
<code class="docutils literal notranslate"><span class="pre">main</span></code> branch. This is primarily done so that the released tag is on the main branch
so <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">describe</span></code> (and thus <code class="docutils literal notranslate"><span class="pre">setuptools-scm</span></code>) has the most current tag.
Secondarily, changes made during release (including removing individualized release
notes, fixing broken links, and updating the version switcher) are bubbled up to
<code class="docutils literal notranslate"><span class="pre">main</span></code>.</p>
<p>Git conflicts are very likely to arise, though aside from changes made directly to the
release branch (mostly as part of the release), they should be relatively-easily resolved
by using the version from <code class="docutils literal notranslate"><span class="pre">main</span></code>. This is not a universal rule, and care should be
taken to ensure correctness:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>switch<span class="w"> </span>main
git<span class="w"> </span>pull
git<span class="w"> </span>switch<span class="w"> </span>-c<span class="w"> </span>merge_up_v3.7.0
git<span class="w"> </span>merge<span class="w"> </span>v3.7.x
<span class="c1"># resolve conflicts</span>
git<span class="w"> </span>merge<span class="w"> </span>--continue
</pre></div>
</div>
<p>Due to branch protections for the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, this is merged via a standard pull
request, though the PR cleanliness status check is expected to fail. The PR should not
be squashed because the intent is to merge the branch histories.</p>
</section>
<section id="publicize-this-release">
<h2>Publicize this release<a class="headerlink" href="#publicize-this-release" title="Link to this heading">#</a></h2>
<p>After the release is published to PyPI and conda, it should be announced
through our communication channels:</p>
<ul class="checklist simple">
<li><p>Send a short version of the release notes and acknowledgments to all the <a class="reference internal" href="communication_guide.html#mailing-lists"><span class="std std-ref">Mailing lists</span></a></p></li>
<li><p>Post highlights and link to <a class="reference internal" href="../users/release_notes.html#release-notes"><span class="std std-ref">What's new</span></a> on the
active <a class="reference internal" href="communication_guide.html#social-media"><span class="std std-ref">social media accounts</span></a></p></li>
<li><p>Add a release announcement to the "News" section of
<a class="reference external" href="https://github.com/matplotlib/mpl-brochure-site">matplotlib.org</a> by editing
<code class="docutils literal notranslate"><span class="pre">docs/body.html</span></code>. Link to the auto-generated announcement discourse post,
which is in <a class="reference external" href="https://discourse.matplotlib.org/c/announce/matplotlib-announce/10">Announcements > matplotlib-announcements</a>.</p></li>
</ul>
</section>
<section id="conda-packages">
<h2>Conda packages<a class="headerlink" href="#conda-packages" title="Link to this heading">#</a></h2>
<p>The Matplotlib project itself does not release conda packages. In particular,
the Matplotlib release manager is not responsible for conda packaging.</p>
<p>For information on the packaging of Matplotlib for conda-forge see
<a class="github reference external" href="https://github.com/conda-forge/matplotlib-feedstock">conda-forge/matplotlib-feedstock</a>.</p>
</section>
</section>
</article>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#making-the-release-branch">Making the release branch</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#testing">Testing</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#github-statistics">GitHub statistics</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#update-and-validate-the-docs">Update and validate the docs</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#merge-doc-branch">Merge <code class="docutils literal notranslate"><span class="pre">*-doc</span></code> branch</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#update-supported-versions-in-security-policy">Update supported versions in Security Policy</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#update-release-notes">Update release notes</a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#what-s-new">What's new</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#api-changes">API changes</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#release-notes-toc">Release notes TOC</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#update-version-switcher">Update version switcher</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#verify-that-docs-build">Verify that docs build</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#create-release-commit-and-tag">Create release commit and tag</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#release-management-doi">Release management / DOI</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-binaries">Building binaries</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#make-distribution-and-upload-to-pypi">Make distribution and upload to PyPI</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#build-and-deploy-documentation">Build and deploy documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#merge-up-changes-to-main">Merge up changes to main</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#publicize-this-release">Publicize this release</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#conda-packages">Conda packages</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
You can’t perform that action at this time.