Difference between revisions of "Developers:Preparing Release"

From OctopusWiki
Jump to navigation Jump to search
Line 1: Line 1:
For a new major release (''e.g.'' {{octopus_version}}):
+
For a new major release (''e.g.'' {{octopus_major_version}}.0):
* Create a release branch from {{file|develop}}. The branch should be named {{file|release-{{octopus_version}}}}.
+
* Create a release branch from {{file|develop}}. The branch should be named {{file|release-{{octopus_major_version}}.0}}.
 
* Update the version number in {{code|AC_INIT}} in {{file|configure.ac}} and push the changes to the git repository.
 
* Update the version number in {{code|AC_INIT}} in {{file|configure.ac}} and push the changes to the git repository.
* The buildbot will automatically create from the release branch a tarball (http://www.tddft.org/programs/octopus/down.php?file=release-{{octopus_version}}/octopus-{{octopus_version}}.tar.gz), the variable documentation (http://octopus-code.org/doc/release-{{octopus_version}}/html/vars.php), and the doxygen documentation (http://octopus-code.org/doc/release-{{octopus_version}}/doxygen_doc/index.html).
+
* The buildbot will automatically create from the release branch a tarball (http://www.tddft.org/programs/octopus/down.php?file=release-{{octopus_major_version}}.0/octopus-{{octopus_major_version}}.0.tar.gz), the variable documentation (http://octopus-code.org/doc/release-{{octopus_major_version}}.0/html/vars.php), and the doxygen documentation (http://octopus-code.org/doc/release-{{octopus_major_version}}.0/doxygen_doc/index.html).
 
* Distribute the tarball among the developers for testing and correct any problems encountered.
 
* Distribute the tarball among the developers for testing and correct any problems encountered.
 
* Update the {{file|PACKAGING}} file.
 
* Update the {{file|PACKAGING}} file.
Line 9: Line 9:
 
* Add a new tag on [https://gitlab.com/octopus-code/octopus/tags/new Gitlab]:
 
* Add a new tag on [https://gitlab.com/octopus-code/octopus/tags/new Gitlab]:
 
** Create the new tag from the {{file|master}} branch.
 
** Create the new tag from the {{file|master}} branch.
** Tag should be named {{octopus_version}}.
+
** Tag should be named {{octopus_major_version}}.0.
 
** Add a link to [[Octopus {{octopus_major_version}}]] in the release notes.
 
** Add a link to [[Octopus {{octopus_major_version}}]] in the release notes.
** The buildbot will automatically create from the tag a tarball (http://www.tddft.org/programs/octopus/down.php?file={{octopus_version}}/octopus-{{octopus_version}}.tar.gz), the variable documentation (http://octopus-code.org/doc/{{octopus_version}}/html/vars.php), and the doxygen documentation (http://octopus-code.org/doc/{{octopus_version}}/doxygen_doc/index.html).
+
** The buildbot will automatically create from the tag a tarball (http://www.tddft.org/programs/octopus/down.php?file={{octopus_major_version}}.0/octopus-{{octopus_major_version}}.0.tar.gz), the variable documentation (http://octopus-code.org/doc/{{octopus_major_version}}.0/html/vars.php), and the doxygen documentation (http://octopus-code.org/doc/{{octopus_major_version}}.0/doxygen_doc/index.html).
 
* Merge the release branch into {{file|develop}}. This might require to resolve some conflicts, as the {{file|develop}} branch might have diverged.
 
* Merge the release branch into {{file|develop}}. This might require to resolve some conflicts, as the {{file|develop}} branch might have diverged.
 
* Update the codename for the development version in AC_INIT in {{file|configure.ac}} on the {{file|develop}} branch and on the [[FAQ]] page.
 
* Update the codename for the development version in AC_INIT in {{file|configure.ac}} on the {{file|develop}} branch and on the [[FAQ]] page.
* Update the [[Template:Octopus_version]] wiki template.
+
* Update the [[Template:Octopus_major_version]] and the [[Template:Octopus_minor_version]] wiki templates.
 
* Add a new page for the release to the wiki. ''e.g.'' [[Octopus {{octopus_major_version}}]]
 
* Add a new page for the release to the wiki. ''e.g.'' [[Octopus {{octopus_major_version}}]]
 
* Update the [[Changes]] wiki page, referring to [[Developers:Changes]].
 
* Update the [[Changes]] wiki page, referring to [[Developers:Changes]].
Line 29: Line 29:
 
To: octopus-users@tddft.org, octopus-announce@tddft.org  
 
To: octopus-users@tddft.org, octopus-announce@tddft.org  
  
Subject: Octopus {{octopus_version}} released
+
Subject: Octopus {{octopus_major_version}}.0 released
  
 
Dear Octopus users,
 
Dear Octopus users,
  
We are pleased to announce that we have just released Octopus {{octopus_version}}.
+
We are pleased to announce that we have just released Octopus {{octopus_major_version}}.0.
  
 
The source code, documentation and information for this new release can be obtained from:
 
The source code, documentation and information for this new release can be obtained from:

Revision as of 01:32, 13 November 2019

For a new major release (e.g. 10.0):

Sample email

To: octopus-users@tddft.org, octopus-announce@tddft.org

Subject: Octopus 10.0 released

Dear Octopus users,

We are pleased to announce that we have just released Octopus 10.0.

The source code, documentation and information for this new release can be obtained from:

http://octopus-code.org/wiki/Octopus_10

Best regards,

The Octopus development team