-
Notifications
You must be signed in to change notification settings - Fork 81
/
Copy pathmaintainer.html
1268 lines (1042 loc) · 81.3 KB
/
maintainer.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
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" data-content_root="../" >
<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" />
<meta property="og:title" content="Maintainer Information" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://scikit-learn/stable/developers/maintainer.html" />
<meta property="og:site_name" content="scikit-learn" />
<meta property="og:description" content="Releasing: This section is about preparing a major/minor release, a release candidate (RC), or a bug-fix release. We follow PEP440 for the version scheme and to indicate different types of releases..." />
<meta property="og:image" content="https://scikit-learn.org/stable/_static/scikit-learn-logo-small.png" />
<meta property="og:image:alt" content="scikit-learn" />
<meta name="description" content="Releasing: This section is about preparing a major/minor release, a release candidate (RC), or a bug-fix release. We follow PEP440 for the version scheme and to indicate different types of releases..." />
<title>Maintainer Information — scikit-learn 1.6.1 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
<link rel="stylesheet" type="text/css" href="../_static/jupyterlite_sphinx.css?v=e3ca86de" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<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/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/styles/colors.css?v=cc94ab7d" />
<link rel="stylesheet" type="text/css" href="../_static/styles/custom.css?v=d67e4bb0" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=d6a008b6"></script>
<script src="../_static/doctools.js?v=9a2dae69"></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=97f0b27d"></script>
<script src="../_static/jupyterlite_sphinx.js?v=d6bdf5f8"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script data-domain="scikit-learn.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'developers/maintainer';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://scikit-learn.org/dev/_static/versions.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.6.1';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<script src="../_static/scripts/dropdown.js?v=e2048168"></script>
<script src="../_static/scripts/version-switcher.js?v=a6dd8357"></script>
<script src="../_static/scripts/sg_plotly_resize.js?v=eeb41cab"></script>
<link rel="canonical" href="https://scikit-learn.org/stable/developers/maintainer.html" />
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.6" />
</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="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<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"
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>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class=" navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../index.html">
<img src="../_static/scikit-learn-logo-small.png" class="logo__image only-light" alt="scikit-learn homepage"/>
<img src="../_static/scikit-learn-logo-small.png" class="logo__image only-dark pst-js-only" alt="scikit-learn homepage"/>
</a></div>
</div>
<div class=" navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../user_guide.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../api/index.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../auto_examples/index.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://blog.scikit-learn.org/">
Community
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../getting_started.html">
Getting Started
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../whats_new.html">
Release History
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../glossary.html">
Glossary
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-external" href="https://scikit-learn.org/dev/developers/index.html">
Development
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../faq.html">
FAQ
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../support.html">
Support
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../related_projects.html">
Related Projects
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../roadmap.html">
Roadmap
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../governance.html">
Governance
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="../about.html">
About us
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/scikit-learn/scikit-learn" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../user_guide.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../api/index.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../auto_examples/index.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://blog.scikit-learn.org/">
Community
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../getting_started.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../whats_new.html">
Release History
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../glossary.html">
Glossary
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://scikit-learn.org/dev/developers/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../faq.html">
FAQ
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../support.html">
Support
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../related_projects.html">
Related Projects
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../roadmap.html">
Roadmap
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../governance.html">
Governance
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../about.html">
About us
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/scikit-learn/scikit-learn" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></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"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<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 active" aria-current="page"><span class="ellipsis">Maintainer Information</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="maintainer-information">
<h1>Maintainer Information<a class="headerlink" href="#maintainer-information" title="Link to this heading">#</a></h1>
<section id="releasing">
<h2>Releasing<a class="headerlink" href="#releasing" title="Link to this heading">#</a></h2>
<p>This section is about preparing a major/minor release, a release candidate (RC), or a
bug-fix release. We follow <a class="reference external" href="https://www.python.org/dev/peps/pep-0440/">PEP440</a> for
the version scheme and to indicate different types of releases. Our convention is to
follow the “major.minor.micro” scheme, although in practice there is no fundamental
difference between major and minor releases and micro releases are bug-fix releases.</p>
<p>We adopted the following release schedule:</p>
<ul class="simple">
<li><p>Major/Minor releases every 6 months, usually in May and November. These releases
are numbered <code class="docutils literal notranslate"><span class="pre">X.Y.0</span></code> and are preceded by one or more release candidates <code class="docutils literal notranslate"><span class="pre">X.Y.0rcN</span></code>.</p></li>
<li><p>Bug-fix releases are done as needed between major/minor releases and only apply to
the last stable version. These releases are numbered <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code>.</p></li>
</ul>
<p class="rubric">Preparation</p>
<ul class="simple">
<li><p>Confirm that all blockers tagged for the milestone have been resolved, and that other
issues tagged for the milestone can be postponed.</p></li>
<li><p>Make sure the deprecations, FIXMEs, and TODOs tagged for the release have been taken
care of.</p></li>
<li><p>For major/minor final releases, make sure that a <em>Release Highlights</em> page has been
done as a runnable example and check that its HTML rendering looks correct. It should
be linked from the what’s new file for the new version of scikit-learn.</p></li>
</ul>
<p class="rubric">Permissions</p>
<ul class="simple">
<li><p>The release manager must be a <strong>maintainer</strong> of the
<a class="github reference external" href="https://github.com/scikit-learn/scikit-learn">scikit-learn/scikit-learn</a> repository to be able to publish on
<code class="docutils literal notranslate"><span class="pre">pypi.org</span></code> and <code class="docutils literal notranslate"><span class="pre">test.pypi.org</span></code> (via a manual trigger of a dedicated Github Actions
workflow).</p></li>
<li><p>The release manager must be a <strong>maintainer</strong> of the
<a class="github reference external" href="https://github.com/conda-forge/scikit-learn-feedstock">conda-forge/scikit-learn-feedstock</a> repository to be able to publish
on <code class="docutils literal notranslate"><span class="pre">conda-forge</span></code>. This can be changed by editing the <code class="docutils literal notranslate"><span class="pre">recipe/meta.yaml</span></code> file in the
first release pull request.</p></li>
</ul>
<section id="reference-steps">
<h3>Reference Steps<a class="headerlink" href="#reference-steps" title="Link to this heading">#</a></h3>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label tab-4" for="sd-tab-item-0">
Major/Minor RC</label><div class="sd-tab-content docutils">
<p>Suppose that we are preparing the release <code class="docutils literal notranslate"><span class="pre">1.7.0rc1</span></code>.</p>
<p>The first RC ideally counts as a <strong>feature freeze</strong>. Each coming release candidate
and the final release afterwards should include only minor documentation changes
and bug fixes. Any major enhancement or new feature should be excluded.</p>
<ul>
<li><p>Create the release branch <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> directly in the main repository,
where <code class="docutils literal notranslate"><span class="pre">X</span></code> is really the letter X, <strong>not a placeholder</strong>. The development for the
final and subsequent bug-fix releases of <code class="docutils literal notranslate"><span class="pre">1.7</span></code> should also happen
under this branch with different tags.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><style type="text/css">
span.prompt1:before {
content: "$ ";
}
</style><span class="prompt1">git<span class="w"> </span>fetch<span class="w"> </span>upstream<span class="w"> </span>main</span>
<span class="prompt1">git<span class="w"> </span>checkout<span class="w"> </span>upstream/main</span>
<span class="prompt1">git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span><span class="m">1</span>.7.X</span>
<span class="prompt1">git<span class="w"> </span>push<span class="w"> </span>--set-upstream<span class="w"> </span>upstream<span class="w"> </span><span class="m">1</span>.7.X</span>
</pre></div></div></li>
<li><p>Create a PR targeting the <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> branch.
Copy the following release checklist to the description of this PR to track the
progress.</p>
<div class="highlight-markdown notranslate"><div class="highlight"><pre><span></span><span class="k">* [ ]</span> Update the sklearn dev0 version in main branch
<span class="k">* [ ]</span> Set the version number in the release branch
<span class="k">* [ ]</span> Generate the changelog in the release branch
<span class="k">* [ ]</span> Check that the wheels for the release can be built successfully
<span class="k">* [ ]</span> Merge the PR with <span class="sb">`[cd build]`</span> commit message to upload wheels to the staging repo
<span class="k">* [ ]</span> Upload the wheels and source tarball to https://test.pypi.org
<span class="k">* [ ]</span> Create tag on the main repo
<span class="k">* [ ]</span> Confirm bot detected at https://github.com/conda-forge/scikit-learn-feedstock
and wait for merge
<span class="k">* [ ]</span> Upload the wheels and source tarball to PyPI
<span class="k">* [ ]</span> Announce on mailing list and on social media platforms (LinkedIn, Bluesky, etc.)
</pre></div>
</div>
</li>
<li><p>Create a PR from <code class="docutils literal notranslate"><span class="pre">main</span></code> and targeting <code class="docutils literal notranslate"><span class="pre">main</span></code> to prepare for the next version. In
this PR you need to:</p>
<ul class="simple">
<li><p>Increment the dev0 <code class="docutils literal notranslate"><span class="pre">__version__</span></code> variable in <code class="docutils literal notranslate"><span class="pre">sklearn/__init__.py</span></code>. This means
that while we are in the release candidate period, the latest stable is two
versions behind the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, instead of one.</p></li>
<li><p>Include a new what’s new file under the <code class="docutils literal notranslate"><span class="pre">doc/whats_new/</span></code> directory. Don’t forget
to add an entry for this new file in <code class="docutils literal notranslate"><span class="pre">doc/whats_new.rst</span></code>.</p></li>
<li><p>Change the what’s new file to the newly created one in the <code class="docutils literal notranslate"><span class="pre">filename</span></code> field of
the <code class="docutils literal notranslate"><span class="pre">tool.towncrier</span></code> section in <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>.</p></li>
</ul>
</li>
<li><p>In the release branch, change the version number <code class="docutils literal notranslate"><span class="pre">__version__</span></code> in
<code class="docutils literal notranslate"><span class="pre">sklearn/__init__.py</span></code> to <code class="docutils literal notranslate"><span class="pre">1.7.0rc1</span></code>.</p></li>
<li><p>In the release branch, generate the changelog for the incoming version, i.e.,
<code class="docutils literal notranslate"><span class="pre">doc/whats_new/1.7.rst</span></code>.
During the RC period we want to keep the fragments when we generate the changelog
because we’ll generate it again for the final release, including the changes that
may happen in between:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">towncrier<span class="w"> </span>build<span class="w"> </span>--keep<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.7.0</span>
</pre></div></div></li>
<li><p>Trigger the wheel builder with the <code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> commit marker. See also the
<a class="reference external" href="https://github.com/scikit-learn/scikit-learn/actions/workflows/wheels.yml">workflow runs of the wheel builder</a>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>commit<span class="w"> </span>--allow-empty<span class="w"> </span>-m<span class="w"> </span><span class="s2">"[cd build] Trigger wheel builder workflow"</span></span>
</pre></div></div><div class="admonition note">
<p class="admonition-title">Note</p>
<p>The acronym CD in <code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> stands for <a class="reference external" href="https://en.wikipedia.org/wiki/Continuous_delivery">Continuous Delivery</a> and refers to the
automation used to generate the release artifacts (binary and source
packages). This can be seen as an extension to CI which stands for <a class="reference external" href="https://en.wikipedia.org/wiki/Continuous_integration">Continuous
Integration</a>. The CD
workflow on GitHub Actions is also used to automatically create nightly builds
and publish packages for the development branch of scikit-learn. See also
<a class="reference internal" href="advanced_installation.html#install-nightly-builds"><span class="std std-ref">Installing nightly builds</span></a>.</p>
</div>
</li>
<li><p>Once all the CD jobs have completed successfully in the PR, merge it with the
<code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> marker in the commit message. This time the results will be
uploaded to the staging area. You should then be able to upload the generated
artifacts (<code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code> and <code class="docutils literal notranslate"><span class="pre">.whl</span></code> files) to <a class="reference external" href="https://test.pypi.org/">https://test.pypi.org/</a> using the “Run
workflow” form for the <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/actions/workflows/publish_pypi.yml">PyPI publishing workflow</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This PR should be merged with the rebase mode instead of the usual squash mode
because we want to keep the history in the <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> branch close
to the history of the main branch which will help for future bug fix releases.</p>
<p>In addition if on merging, the last commit, containing the <code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> marker,
is empty, the CD jobs won’t be triggered. In this case, you can directly push
a commit with the marker in the <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> branch to trigger them.</p>
</div>
</li>
<li><p>If the steps above went fine, proceed <strong>with caution</strong> to create a new tag for the
release. This should be done only when you are almost certain that the release is
ready, since adding a new tag to the main repository can trigger certain automated
processes.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>tag<span class="w"> </span>-a<span class="w"> </span><span class="m">1</span>.7.0rc1<span class="w"> </span><span class="c1"># in the 1.7.X branch</span></span>
<span class="prompt1">git<span class="w"> </span>push<span class="w"> </span>[email protected]:scikit-learn/scikit-learn.git<span class="w"> </span><span class="m">1</span>.7.0rc1</span>
</pre></div></div><div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Don’t use the github interface for publishing the release as a way to create the
tag because it will automatically send notifications to all users that follow
the repo even though the website isn’t updated and wheels aren’t uploaded yet.</p>
</div>
</li>
<li><p>Confirm that the bot has detected the tag on the conda-forge feedstock repository
<a class="github reference external" href="https://github.com/conda-forge/scikit-learn-feedstock">conda-forge/scikit-learn-feedstock</a>. If not, submit a PR for the
release, targeting the <code class="docutils literal notranslate"><span class="pre">rc</span></code> branch.
Make sure to update the PR such that it will be synchronized with the <code class="docutils literal notranslate"><span class="pre">main</span></code>
branch. In particular, backport migrations that may have been added since the last
release.</p></li>
<li><p>Trigger the <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/actions/workflows/publish_pypi.yml">PyPI publishing workflow</a>
again, but this time to upload the artifacts to the real <a class="reference external" href="https://pypi.org/">https://pypi.org/</a>. To do
so, replace <code class="docutils literal notranslate"><span class="pre">testpypi</span></code> with <code class="docutils literal notranslate"><span class="pre">pypi</span></code> in the “Run workflow” form.</p>
<p><strong>Alternatively</strong>, it is possible to collect locally the generated binary wheel
packages and source tarball and upload them all to PyPI.</p>
<details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3" id="uploading-artifacts-from-local">
<summary class="sd-summary-title sd-card-header">
<span class="sd-summary-text">Uploading artifacts from local<a class="headerlink" href="#uploading-artifacts-from-local" title="Link to this dropdown">#</a></span><span class="sd-summary-state-marker sd-summary-chevron-right"><svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-right" viewBox="0 0 24 24" aria-hidden="true"><path d="M8.72 18.78a.75.75 0 0 1 0-1.06L14.44 12 8.72 6.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0Z"></path></svg></span></summary><div class="sd-summary-content sd-card-body docutils">
<p class="sd-card-text">Check out at the release tag and run the following commands.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">rm<span class="w"> </span>-r<span class="w"> </span>dist</span>
<span class="prompt1">python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>wheelhouse_uploader<span class="w"> </span>twine</span>
<span class="prompt1">python<span class="w"> </span>-m<span class="w"> </span>wheelhouse_uploader<span class="w"> </span>fetch<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.7.0rc1<span class="w"> </span>--local-folder<span class="w"> </span>dist<span class="w"> </span>scikit-learn<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>https://pypi.anaconda.org/scikit-learn-wheels-staging/simple/scikit-learn/</span>
</pre></div></div><p class="sd-card-text">These commands will download all the binary packages accumulated in the <a class="reference external" href="https://anaconda.org/scikit-learn-wheels-staging/scikit-learn/files">staging
area on the anaconda.org hosting service</a> and put
them in your local <code class="docutils literal notranslate"><span class="pre">./dist</span></code> folder. Check the contents of the <code class="docutils literal notranslate"><span class="pre">./dist</span></code> folder:
it should contain all the wheels along with the source tarball <code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code>. Make
sure you do not have developer versions or older versions of the scikit-learn
package in that folder. Before uploading to PyPI, you can test uploading to
<code class="docutils literal notranslate"><span class="pre">test.pypi.org</span></code> first.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">twine<span class="w"> </span>upload<span class="w"> </span>--verbose<span class="w"> </span>--repository-url<span class="w"> </span>https://test.pypi.org/legacy/<span class="w"> </span>dist/*</span>
</pre></div></div><p class="sd-card-text">Then upload everything at once to <code class="docutils literal notranslate"><span class="pre">pypi.org</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">twine<span class="w"> </span>upload<span class="w"> </span>dist/*</span>
</pre></div></div></div>
</details></li>
</ul>
</div>
<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label tab-4" for="sd-tab-item-1">
Major/Minor Final</label><div class="sd-tab-content docutils">
<p>Suppose that we are preparing the release <code class="docutils literal notranslate"><span class="pre">1.7.0</span></code>.</p>
<ul>
<li><p>Create a new branch from the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, then start an interactive rebase from
<code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> to select the commits that need to be backported:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>rebase<span class="w"> </span>-i<span class="w"> </span>upstream/1.7.X</span>
</pre></div></div><p>This will open an interactive rebase with the <code class="docutils literal notranslate"><span class="pre">git-rebase-todo</span></code> containing all the
latest commits on <code class="docutils literal notranslate"><span class="pre">main</span></code>. At this stage, you have to perform this interactive
rebase with at least someone else (to not forget something and to avoid doubts).</p>
<ul class="simple">
<li><p>Do not remove lines but drop commit by replacing <code class="docutils literal notranslate"><span class="pre">pick</span></code> with <code class="docutils literal notranslate"><span class="pre">drop</span></code>.</p></li>
<li><p>Commits to pick for a bug-fix release are <em>generally</em> prefixed with <code class="docutils literal notranslate"><span class="pre">FIX</span></code>, <code class="docutils literal notranslate"><span class="pre">CI</span></code>,
and <code class="docutils literal notranslate"><span class="pre">DOC</span></code>. They should at least include all the commits of the merged PRs that
were milestoned for this release.</p></li>
<li><p>Commits to <code class="docutils literal notranslate"><span class="pre">drop</span></code> for a bug-fix release are <em>generally</em> prefixed with <code class="docutils literal notranslate"><span class="pre">FEAT</span></code>,
<code class="docutils literal notranslate"><span class="pre">MAINT</span></code>, <code class="docutils literal notranslate"><span class="pre">ENH</span></code>, and <code class="docutils literal notranslate"><span class="pre">API</span></code>. Reasons for not including them is to prevent change
of behavior (which should only happen in major/minor releases).</p></li>
<li><p>After having dropped or picked commits, <strong>do not exit</strong> but paste the content of
the <code class="docutils literal notranslate"><span class="pre">git-rebase-todo</span></code> message in the PR. This file is located at
<code class="docutils literal notranslate"><span class="pre">.git/rebase-merge/git-rebase-todo</span></code>.</p></li>
<li><p>Save and exit to start the interactive rebase. Resolve merge conflicts when
necessary.</p></li>
</ul>
</li>
<li><p>Create a PR targeting the <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> branch.
Copy the following release checklist to the description of this PR to track the
progress.</p>
<div class="highlight-markdown notranslate"><div class="highlight"><pre><span></span><span class="k">* [ ]</span> Set the version number in the release branch
<span class="k">* [ ]</span> Generate the changelog in the release branch
<span class="k">* [ ]</span> Check that the wheels for the release can be built successfully
<span class="k">* [ ]</span> Merge the PR with <span class="sb">`[cd build]`</span> commit message to upload wheels to the staging repo
<span class="k">* [ ]</span> Upload the wheels and source tarball to https://test.pypi.org
<span class="k">* [ ]</span> Create tag on the main repo
<span class="k">* [ ]</span> Confirm bot detected at https://github.com/conda-forge/scikit-learn-feedstock
and wait for merge
<span class="k">* [ ]</span> Upload the wheels and source tarball to PyPI
<span class="k">* [ ]</span> Update news and what's new date in main branch
<span class="k">* [ ]</span> Backport news and what's new date in release branch
<span class="k">* [ ]</span> Update symlink for stable in https://github.com/scikit-learn/scikit-learn.github.io
<span class="k">* [ ]</span> Publish to https://github.com/scikit-learn/scikit-learn/releases
<span class="k">* [ ]</span> Announce on mailing list and on social media platforms (LinkedIn, Bluesky, etc.)
<span class="k">* [ ]</span> Update SECURITY.md in main branch
</pre></div>
</div>
</li>
<li><p>In the release branch, change the version number <code class="docutils literal notranslate"><span class="pre">__version__</span></code> in
<code class="docutils literal notranslate"><span class="pre">sklearn/__init__.py</span></code> to <code class="docutils literal notranslate"><span class="pre">1.7.0</span></code>.</p></li>
<li><p>In the release branch, generate the changelog for the incoming version, i.e.,
<code class="docutils literal notranslate"><span class="pre">doc/whats_new/1.7.rst</span></code>.
For a non RC release, push a commit where you:</p>
<ul>
<li><p>Generate the changelog, not keeping the fragments.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">towncrier<span class="w"> </span>build<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.7.0</span>
</pre></div></div></li>
<li><p>Link the release highlights example.</p></li>
<li><p>Add the list of contributor names. Suppose that the tag of the last release in
the previous major/minor version is <code class="docutils literal notranslate"><span class="pre">1.6.1</span></code>, then you can use the
following command to retrieve the list of contributor names:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>shortlog<span class="w"> </span>-s<span class="w"> </span><span class="m">1</span>.6.1..<span class="w"> </span><span class="p">|</span></span>
<span class="prompt1"><span class="w"> </span>cut<span class="w"> </span>-f2-<span class="w"> </span><span class="p">|</span></span>
<span class="prompt1"><span class="w"> </span>sort<span class="w"> </span>--ignore-case<span class="w"> </span><span class="p">|</span></span>
<span class="prompt1"><span class="w"> </span>tr<span class="w"> </span><span class="s2">"\n"</span><span class="w"> </span><span class="s2">";"</span><span class="w"> </span><span class="p">|</span></span>
<span class="prompt1"><span class="w"> </span>sed<span class="w"> </span><span class="s2">"s/;/, /g;s/, </span>$<span class="s2">//"</span><span class="w"> </span><span class="p">|</span></span>
<span class="prompt1"><span class="w"> </span>fold<span class="w"> </span>-s</span>
</pre></div></div></li>
</ul>
<p>Then create a PR targeting the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch and cherry-pick this commit there.</p>
</li>
<li><p>Trigger the wheel builder with the <code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> commit marker. See also the
<a class="reference external" href="https://github.com/scikit-learn/scikit-learn/actions/workflows/wheels.yml">workflow runs of the wheel builder</a>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>commit<span class="w"> </span>--allow-empty<span class="w"> </span>-m<span class="w"> </span><span class="s2">"[cd build] Trigger wheel builder workflow"</span></span>
</pre></div></div><div class="admonition note">
<p class="admonition-title">Note</p>
<p>The acronym CD in <code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> stands for <a class="reference external" href="https://en.wikipedia.org/wiki/Continuous_delivery">Continuous Delivery</a> and refers to the
automation used to generate the release artifacts (binary and source
packages). This can be seen as an extension to CI which stands for <a class="reference external" href="https://en.wikipedia.org/wiki/Continuous_integration">Continuous
Integration</a>. The CD
workflow on GitHub Actions is also used to automatically create nightly builds
and publish packages for the development branch of scikit-learn. See also
<a class="reference internal" href="advanced_installation.html#install-nightly-builds"><span class="std std-ref">Installing nightly builds</span></a>.</p>
</div>
</li>
<li><p>Once all the CD jobs have completed successfully in the PR, merge it with the
<code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> marker in the commit message. This time the results will be
uploaded to the staging area. You should then be able to upload the generated
artifacts (<code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code> and <code class="docutils literal notranslate"><span class="pre">.whl</span></code> files) to <a class="reference external" href="https://test.pypi.org/">https://test.pypi.org/</a> using the “Run
workflow” form for the <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/actions/workflows/publish_pypi.yml">PyPI publishing workflow</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This PR should be merged with the rebase mode instead of the usual squash mode
because we want to keep the history in the <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> branch close
to the history of the main branch which will help for future bug fix releases.</p>
<p>In addition if on merging, the last commit, containing the <code class="docutils literal notranslate"><span class="pre">[cd</span> <span class="pre">build]</span></code> marker,
is empty, the CD jobs won’t be triggered. In this case, you can directly push
a commit with the marker in the <code class="docutils literal notranslate"><span class="pre">1.7.X</span></code> branch to trigger them.</p>
</div>
</li>
<li><p>If the steps above went fine, proceed <strong>with caution</strong> to create a new tag for the
release. This should be done only when you are almost certain that the release is
ready, since adding a new tag to the main repository can trigger certain automated
processes.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>tag<span class="w"> </span>-a<span class="w"> </span><span class="m">1</span>.7.0<span class="w"> </span><span class="c1"># in the 1.7.X branch</span></span>
<span class="prompt1">git<span class="w"> </span>push<span class="w"> </span>[email protected]:scikit-learn/scikit-learn.git<span class="w"> </span><span class="m">1</span>.7.0</span>
</pre></div></div><div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Don’t use the github interface for publishing the release as a way to create the
tag because it will automatically send notifications to all users that follow
the repo even though the website isn’t updated and wheels aren’t uploaded yet.</p>
</div>
</li>
<li><p>Confirm that the bot has detected the tag on the conda-forge feedstock repository
<a class="github reference external" href="https://github.com/conda-forge/scikit-learn-feedstock">conda-forge/scikit-learn-feedstock</a>. If not, submit a PR for the
release, targeting the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch.</p></li>
<li><p>Trigger the <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/actions/workflows/publish_pypi.yml">PyPI publishing workflow</a>
again, but this time to upload the artifacts to the real <a class="reference external" href="https://pypi.org/">https://pypi.org/</a>. To do
so, replace <code class="docutils literal notranslate"><span class="pre">testpypi</span></code> with <code class="docutils literal notranslate"><span class="pre">pypi</span></code> in the “Run workflow” form.</p>
<p><strong>Alternatively</strong>, it is possible to collect locally the generated binary wheel
packages and source tarball and upload them all to PyPI.</p>
<details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3" id="uploading-artifacts-from-local-2">
<summary class="sd-summary-title sd-card-header">
<span class="sd-summary-text">Uploading artifacts from local<a class="headerlink" href="#uploading-artifacts-from-local-2" title="Link to this dropdown">#</a></span><span class="sd-summary-state-marker sd-summary-chevron-right"><svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-right" viewBox="0 0 24 24" aria-hidden="true"><path d="M8.72 18.78a.75.75 0 0 1 0-1.06L14.44 12 8.72 6.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0Z"></path></svg></span></summary><div class="sd-summary-content sd-card-body docutils">
<p class="sd-card-text">Check out at the release tag and run the following commands.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">rm<span class="w"> </span>-r<span class="w"> </span>dist</span>
<span class="prompt1">python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>wheelhouse_uploader<span class="w"> </span>twine</span>
<span class="prompt1">python<span class="w"> </span>-m<span class="w"> </span>wheelhouse_uploader<span class="w"> </span>fetch<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.7.0<span class="w"> </span>--local-folder<span class="w"> </span>dist<span class="w"> </span>scikit-learn<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>https://pypi.anaconda.org/scikit-learn-wheels-staging/simple/scikit-learn/</span>
</pre></div></div><p class="sd-card-text">These commands will download all the binary packages accumulated in the <a class="reference external" href="https://anaconda.org/scikit-learn-wheels-staging/scikit-learn/files">staging
area on the anaconda.org hosting service</a> and put
them in your local <code class="docutils literal notranslate"><span class="pre">./dist</span></code> folder. Check the contents of the <code class="docutils literal notranslate"><span class="pre">./dist</span></code> folder:
it should contain all the wheels along with the source tarball <code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code>. Make
sure you do not have developer versions or older versions of the scikit-learn
package in that folder. Before uploading to PyPI, you can test uploading to
<code class="docutils literal notranslate"><span class="pre">test.pypi.org</span></code> first.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">twine<span class="w"> </span>upload<span class="w"> </span>--verbose<span class="w"> </span>--repository-url<span class="w"> </span>https://test.pypi.org/legacy/<span class="w"> </span>dist/*</span>
</pre></div></div><p class="sd-card-text">Then upload everything at once to <code class="docutils literal notranslate"><span class="pre">pypi.org</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">twine<span class="w"> </span>upload<span class="w"> </span>dist/*</span>
</pre></div></div></div>
</details></li>
<li><p>In the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, edit <code class="docutils literal notranslate"><span class="pre">doc/templates/index.html</span></code> to change the “News” section
in the landing page, along with the month of the release.
Do not forget to remove old entries (two years or three releases ago) and update
the “On-going development” entry.
Then cherry-pick it in the release branch.</p></li>
<li><p>Update the symlink for <code class="docutils literal notranslate"><span class="pre">stable</span></code> and the <code class="docutils literal notranslate"><span class="pre">latestStable</span></code> variable in
<code class="docutils literal notranslate"><span class="pre">versionwarning.js</span></code> in <a class="github reference external" href="https://github.com/scikit-learn/scikit-learn.github.io">scikit-learn/scikit-learn.github.io</a>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1"><span class="nb">cd</span><span class="w"> </span>/tmp</span>
<span class="prompt1">git<span class="w"> </span>clone<span class="w"> </span>--depth<span class="w"> </span><span class="m">1</span><span class="w"> </span>--no-checkout<span class="w"> </span>[email protected]:scikit-learn/scikit-learn.github.io.git</span>
<span class="prompt1"><span class="nb">cd</span><span class="w"> </span>scikit-learn.github.io</span>
<span class="prompt1"><span class="nb">echo</span><span class="w"> </span>stable<span class="w"> </span>><span class="w"> </span>.git/info/sparse-checkout</span>
<span class="prompt1">git<span class="w"> </span>checkout<span class="w"> </span>main</span>
<span class="prompt1">rm<span class="w"> </span>stable</span>
<span class="prompt1">ln<span class="w"> </span>-s<span class="w"> </span><span class="m">1</span>.7<span class="w"> </span>stable</span>
<span class="prompt1">sed<span class="w"> </span>-i<span class="w"> </span><span class="s2">"s/latestStable = '.*/latestStable = '1.7';/"</span><span class="w"> </span>versionwarning.js</span>
<span class="prompt1">git<span class="w"> </span>add<span class="w"> </span>stable<span class="w"> </span>versionwarning.js</span>
<span class="prompt1">git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"Update stable to point to 1.7"</span></span>
<span class="prompt1">git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>main</span>
</pre></div></div></li>
<li><p>Publish the release at <a class="github reference external" href="https://github.com/scikit-learn/scikit-learn/releases">scikit-learn/scikit-learn</a> and
announce it on the mailing list and social networks. Remember to add a link to the
changelog in the release note. Ideally, only perform this step once the package
is available both on PyPI and conda-forge and once the website is up to date.</p></li>
<li><p>Update <code class="docutils literal notranslate"><span class="pre">SECURITY.md</span></code> to reflect the latest supported version <code class="docutils literal notranslate"><span class="pre">1.7.0</span></code>.</p></li>
</ul>
</div>
<input id="sd-tab-item-2" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label tab-4" for="sd-tab-item-2">
Bug-fix</label><div class="sd-tab-content docutils">
<p>Suppose that we are preparing the release <code class="docutils literal notranslate"><span class="pre">1.6.2</span></code>.</p>
<ul>
<li><p>Create a new branch from the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, then start an interactive rebase from
<code class="docutils literal notranslate"><span class="pre">1.6.X</span></code> to select the commits that need to be backported:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">git<span class="w"> </span>rebase<span class="w"> </span>-i<span class="w"> </span>upstream/1.6.X</span>
</pre></div></div><p>This will open an interactive rebase with the <code class="docutils literal notranslate"><span class="pre">git-rebase-todo</span></code> containing all the
latest commits on <code class="docutils literal notranslate"><span class="pre">main</span></code>. At this stage, you have to perform this interactive
rebase with at least someone else (to not forget something and to avoid doubts).</p>
<ul class="simple">
<li><p>Do not remove lines but drop commit by replacing <code class="docutils literal notranslate"><span class="pre">pick</span></code> with <code class="docutils literal notranslate"><span class="pre">drop</span></code>.</p></li>
<li><p>Commits to pick for a bug-fix release are <em>generally</em> prefixed with <code class="docutils literal notranslate"><span class="pre">FIX</span></code>, <code class="docutils literal notranslate"><span class="pre">CI</span></code>,
and <code class="docutils literal notranslate"><span class="pre">DOC</span></code>. They should at least include all the commits of the merged PRs that
were milestoned for this release.</p></li>
<li><p>Commits to <code class="docutils literal notranslate"><span class="pre">drop</span></code> for a bug-fix release are <em>generally</em> prefixed with <code class="docutils literal notranslate"><span class="pre">FEAT</span></code>,
<code class="docutils literal notranslate"><span class="pre">MAINT</span></code>, <code class="docutils literal notranslate"><span class="pre">ENH</span></code>, and <code class="docutils literal notranslate"><span class="pre">API</span></code>. Reasons for not including them is to prevent change
of behavior (which should only happen in major/minor releases).</p></li>
<li><p>After having dropped or picked commits, <strong>do not exit</strong> but paste the content of
the <code class="docutils literal notranslate"><span class="pre">git-rebase-todo</span></code> message in the PR. This file is located at
<code class="docutils literal notranslate"><span class="pre">.git/rebase-merge/git-rebase-todo</span></code>.</p></li>
<li><p>Save and exit to start the interactive rebase. Resolve merge conflicts when
necessary.</p></li>
</ul>
</li>
<li><p>Create a PR targeting the <code class="docutils literal notranslate"><span class="pre">1.6.X</span></code> branch.
Copy the following release checklist to the description of this PR to track the
progress.</p>
<div class="highlight-markdown notranslate"><div class="highlight"><pre><span></span><span class="k">* [ ]</span> Set the version number in the release branch
<span class="k">* [ ]</span> Generate the changelog in the release branch
<span class="k">* [ ]</span> Check that the wheels for the release can be built successfully
<span class="k">* [ ]</span> Merge the PR with <span class="sb">`[cd build]`</span> commit message to upload wheels to the staging repo
<span class="k">* [ ]</span> Upload the wheels and source tarball to https://test.pypi.org
<span class="k">* [ ]</span> Create tag on the main repo
<span class="k">* [ ]</span> Confirm bot detected at https://github.com/conda-forge/scikit-learn-feedstock
and wait for merge
<span class="k">* [ ]</span> Upload the wheels and source tarball to PyPI
<span class="k">* [ ]</span> Update news and what's new date in main branch
<span class="k">* [ ]</span> Backport news and what's new date in release branch
<span class="k">* [ ]</span> Publish to https://github.com/scikit-learn/scikit-learn/releases
<span class="k">* [ ]</span> Announce on mailing list and on social media platforms (LinkedIn, Bluesky, etc.)
<span class="k">* [ ]</span> Update SECURITY.md in main branch
</pre></div>
</div>
</li>
<li><p>In the release branch, change the version number <code class="docutils literal notranslate"><span class="pre">__version__</span></code> in
<code class="docutils literal notranslate"><span class="pre">sklearn/__init__.py</span></code> to <code class="docutils literal notranslate"><span class="pre">1.6.2</span></code>.</p></li>
<li><p>In the release branch, generate the changelog for the incoming version, i.e.,
<code class="docutils literal notranslate"><span class="pre">doc/whats_new/1.6.rst</span></code>.
For a non RC release, push a commit where you:</p>
<ul>
<li><p>Generate the changelog, not keeping the fragments.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="prompt1">towncrier<span class="w"> </span>build<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.6.2</span>
</pre></div></div></li>
<li><p>Add the list of contributor names. Suppose that the tag of the last release in
the previous major/minor version is <code class="docutils literal notranslate"><span class="pre">1.5.2</span></code>, then you can use the