commit de31f879bd1a08ed35f9e3b632a5ab22837b58be · pyrox.dev/nixpkgs

+40 -27

nixos/doc/manual/development/releases.xml

···

       10
        
         <title>Release process</title>

     

       11
        
       

     

       12
        
         <para>

     

       13
       -
           Going through an example of releasing NixOS 15.09:

     

       14
        
         </para>

     

       15
        
       

     

       16
        
         <section xml:id="one-month-before-the-beta">

     
···

       18
        
           <itemizedlist spacing="compact">

     

       19
        
             <listitem>

     

       20
        
               <para>

     

       21
       -
                 Send an email to nix-dev mailinglist as a warning about upcoming beta "feature freeze" in a month.

     

       22
        
               </para>

     

       23
        
             </listitem>

     

       24
        
             <listitem>

     

       25
        
               <para>

     

       26
        
                 Discuss with Eelco Dolstra and the community (via IRC, ML) about what will reach the deadline.

     

       27
       -
                 Any issue or Pull Request targeting the release should have assigned milestone.

     

       28
        
               </para>

     

       29
        
             </listitem>

     

       30
        
           </itemizedlist>

     
···

       34
        
           <itemizedlist spacing="compact">

     

       35
        
             <listitem>

     

       36
        
               <para>

     

       37
       -
                 Rename <literal>rl-unstable.xml</literal> -&gt;

     

       38
       -
                 <literal>rl-1509.xml</literal>.

     

       39
        
               </para>

     

       40
        
             </listitem>

     

       41
        
             <listitem>

     

       42
        
               <para>

     

       43
       -
                 <literal>git tag -a -m &quot;Release 15.09-beta&quot; 15.09-beta &amp;&amp; git push --tags</literal>

     

       44
        
               </para>

     

       45
        
             </listitem>

     

       46
        
             <listitem>

     

       47
        
               <para>

     

       48
       -
                 From the master branch run <literal>git checkout -B release-15.09</literal>.

     

       49
        
               </para>

     

       50
        
             </listitem>

     

       51
        
             <listitem>

     

       52
        
               <para>

     

       53
        
                 <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18">

     

       54
       -
                   Make sure channel is created at http://nixos.org/channels/.

     

       55
        
                 </link>

     

       56
        
               </para>

     

       57
        
             </listitem>

     

       58
        
             <listitem>

     

       59
        
               <para>

     

       60
        
                 <link xlink:href="https://github.com/NixOS/nixpkgs/settings/branches">

     

       61
       -
                   Lock the branch on github (so developers can’t force push)

     

       0
        
       
     

       62
        
                 </link>

     

       63
        
               </para>

     

       64
        
             </listitem>

     

       65
        
             <listitem>

     

       66
        
               <para>

     

       67
       -
                 <link xlink:href="https://github.com/NixOS/nixpkgs/compare/bdf161ed8d21...6b63c4616790">bump

     

       68
       -
                 <literal>system.defaultChannel</literal> attribute in

     

       69
       -
                 <literal>nixos/modules/misc/version.nix</literal></link>

     

       0
        
       
     

       70
        
               </para>

     

       71
        
             </listitem>

     

       72
        
             <listitem>

     

       73
        
               <para>

     

       74
       -
                 <link xlink:href="https://github.com/NixOS/nixpkgs/commit/d6b08acd1ccac0d9d502c4b635e00b04d3387f06">update

     

       75
       -
                 <literal>versionSuffix</literal> in

     

       76
        
                 <literal>nixos/release.nix</literal></link>, use

     

       77
       -
                 <literal>git log --format=%an|wc -l</literal> to get commit

     

       78
        
                 count

     

       79
        
               </para>

     

       80
        
             </listitem>

     

       81
        
             <listitem>

     

       82
        
               <para>

     

       83
       -
                 <literal>echo -n &quot;16.03&quot; &gt; .version</literal> in

     

       84
        
                 master.

     

       85
        
               </para>

     

       86
        
             </listitem>

     

       87
        
             <listitem>

     

       88
        
               <para>

     

       89
       -
                 <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842">pick

     

       90
       -
                 a new name for unstable branch.</link>

     

       0
        
       
     

       91
        
               </para>

     

       92
        
             </listitem>

     

       93
        
             <listitem>

     
···

       99
        
             </listitem>

     

       100
        
             <listitem>

     

       101
        
               <para>

     

       102
       -
                 Use https://lwn.net/Vulnerabilities/ and 

     

       103
       -
                 <link xlink:href="https://github.com/NixOS/nixpkgs/search?utf8=%E2%9C%93&amp;q=vulnerabilities&amp;type=Issues">triage vulnerabilities in an issue</link>.

     

       104
       -
               </para>

     

       105
       -
             </listitem>

     

       106
       -
             <listitem>

     

       107
       -
               <para>

     

       108
       -
                 Create two Hydra jobsets: release-15.09 and release-15.09-small with <literal>stableBranch</literal> set to false

     

       109
        
               </para>

     

       110
        
             </listitem>

     

       111
        
             <listitem>

     

       112
        
               <para>

     

       113
        
                 Edit changelog at

     

       114
       -
                 <literal>nixos/doc/manual/release-notes/rl-1509.xml</literal>

     

       115
        
                 (double check desktop versions are noted)

     

       116
        
               </para>

     

       117
        
               <itemizedlist spacing="compact">

     

       118
        
                 <listitem>

     

       119
        
                   <para>

     

       120
        
                     Get all new NixOS modules

     

       121
       -
                     <literal>git diff release-14.12..release-15.09 nixos/modules/module-list.nix|grep ^+</literal>

     

       122
        
                   </para>

     

       123
        
                 </listitem>

     

       124
        
                 <listitem>

     
···

       130
        
             </listitem>

     

       131
        
           </itemizedlist>

     

       132
        
         </section>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       133
        
         <section xml:id="before-the-final-release">

     

       134
        
           <title>Before the final release</title>

     

       135
        
           <itemizedlist spacing="compact">

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       136
        
             <listitem>

     

       137
        
               <para>

     

       138
        
                 Release Nix (currently only Eelco Dolstra can do that).

···

       10
        
         <title>Release process</title>

     

       11
        
       

     

       12
        
         <para>

     

       13
       +
           Going through an example of releasing NixOS 17.09:

     

       14
        
         </para>

     

       15
        
       

     

       16
        
         <section xml:id="one-month-before-the-beta">

     
···

       18
        
           <itemizedlist spacing="compact">

     

       19
        
             <listitem>

     

       20
        
               <para>

     

       21
       +
                 Send an email to the nix-devel mailinglist as a warning about upcoming beta "feature freeze" in a month.

     

       22
        
               </para>

     

       23
        
             </listitem>

     

       24
        
             <listitem>

     

       25
        
               <para>

     

       26
        
                 Discuss with Eelco Dolstra and the community (via IRC, ML) about what will reach the deadline.

     

       27
       +
                 Any issue or Pull Request targeting the release should be included in the release milestone.

     

       28
        
               </para>

     

       29
        
             </listitem>

     

       30
        
           </itemizedlist>

     
···

       34
        
           <itemizedlist spacing="compact">

     

       35
        
             <listitem>

     

       36
        
               <para>

     

       37
       +
                 Create a new release notes file for the upcoming release + 1, in this

     

       38
       +
                 case <literal>rl-1803.xml</literal>.

     

       39
        
               </para>

     

       40
        
             </listitem>

     

       41
        
             <listitem>

     

       42
        
               <para>

     

       43
       +
                 <literal>git tag -a -s -m &quot;Release 17.09-beta&quot; 17.09-beta &amp;&amp; git push --tags</literal>

     

       44
        
               </para>

     

       45
        
             </listitem>

     

       46
        
             <listitem>

     

       47
        
               <para>

     

       48
       +
                 From the master branch run <literal>git checkout -B release-17.09</literal>.

     

       49
        
               </para>

     

       50
        
             </listitem>

     

       51
        
             <listitem>

     

       52
        
               <para>

     

       53
        
                 <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18">

     

       54
       +
                   Make sure a channel is created at http://nixos.org/channels/.

     

       55
        
                 </link>

     

       56
        
               </para>

     

       57
        
             </listitem>

     

       58
        
             <listitem>

     

       59
        
               <para>

     

       60
        
                 <link xlink:href="https://github.com/NixOS/nixpkgs/settings/branches">

     

       61
       +
                   Let a GitHub nixpkgs admin lock the branch on github for you.

     

       62
       +
                   (so developers can’t force push)

     

       63
        
                 </link>

     

       64
        
               </para>

     

       65
        
             </listitem>

     

       66
        
             <listitem>

     

       67
        
               <para>

     

       68
       +
                 <link xlink:href="https://github.com/NixOS/nixpkgs/compare/bdf161ed8d21...6b63c4616790">

     

       69
       +
                   Bump the <literal>system.defaultChannel</literal> attribute in

     

       70
       +
                   <literal>nixos/modules/misc/version.nix</literal>

     

       71
       +
                 </link>

     

       72
        
               </para>

     

       73
        
             </listitem>

     

       74
        
             <listitem>

     

       75
        
               <para>

     

       76
       +
                 <link xlink:href="https://github.com/NixOS/nixpkgs/commit/d6b08acd1ccac0d9d502c4b635e00b04d3387f06">

     

       77
       +
                   Update <literal>versionSuffix</literal> in

     

       78
        
                 <literal>nixos/release.nix</literal></link>, use

     

       79
       +
                 <literal>git log --format=%an|wc -l</literal> to get the commit

     

       80
        
                 count

     

       81
        
               </para>

     

       82
        
             </listitem>

     

       83
        
             <listitem>

     

       84
        
               <para>

     

       85
       +
                 <literal>echo -n &quot;18.03&quot; &gt; .version</literal> on

     

       86
        
                 master.

     

       87
        
               </para>

     

       88
        
             </listitem>

     

       89
        
             <listitem>

     

       90
        
               <para>

     

       91
       +
                 <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842">

     

       92
       +
                   Pick a new name for the unstable branch.

     

       93
       +
                 </link>

     

       94
        
               </para>

     

       95
        
             </listitem>

     

       96
        
             <listitem>

     
···

       102
        
             </listitem>

     

       103
        
             <listitem>

     

       104
        
               <para>

     

       105
       +
                 Create two Hydra jobsets: release-17.09 and release-17.09-small with <literal>stableBranch</literal> set to false.

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       106
        
               </para>

     

       107
        
             </listitem>

     

       108
        
             <listitem>

     

       109
        
               <para>

     

       110
        
                 Edit changelog at

     

       111
       +
                 <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal>

     

       112
        
                 (double check desktop versions are noted)

     

       113
        
               </para>

     

       114
        
               <itemizedlist spacing="compact">

     

       115
        
                 <listitem>

     

       116
        
                   <para>

     

       117
        
                     Get all new NixOS modules

     

       118
       +
                     <literal>git diff release-17.03..release-17.09 nixos/modules/module-list.nix|grep ^+</literal>

     

       119
        
                   </para>

     

       120
        
                 </listitem>

     

       121
        
                 <listitem>

     
···

       127
        
             </listitem>

     

       128
        
           </itemizedlist>

     

       129
        
         </section>

     

       130
       +
         <section xml:id="during-beta">

     

       131
       +
           <title>During Beta</title>

     

       132
       +
           <itemizedlist spacing="compact">

     

       133
       +
             <listitem>

     

       134
       +
               <para>

     

       135
       +
                 Monitor the master branch for bugfixes and minor updates

     

       136
       +
                 and cherry-pick them to the release branch.

     

       137
       +
               </para>

     

       138
       +
             </listitem>

     

       139
       +
           </itemizedlist>

     

       140
       +
         </section>

     

       141
        
         <section xml:id="before-the-final-release">

     

       142
        
           <title>Before the final release</title>

     

       143
        
           <itemizedlist spacing="compact">

     

       144
       +
             <listitem>

     

       145
       +
               <para>

     

       146
       +
                 Re-check that the release notes are complete.

     

       147
       +
               </para>

     

       148
       +
             </listitem>

     

       149
        
             <listitem>

     

       150
        
               <para>

     

       151
        
                 Release Nix (currently only Eelco Dolstra can do that).