Difference between revisions of "Developers:Preparing Release"

From OctopusWiki
Jump to navigation Jump to search
Line 13: Line 13:
 
** Tag should be named {{octopus_major_version}}.0.
 
** 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_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).
+
** The buildbot will automatically create from the tag a tarball (http://octopus-code.org/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.

Revision as of 14:48, 7 February 2020

Major releases

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

Minor releases

For a new minor release (e.g. 10.1):

  • Create a hotfix branch from master. The branch should be named hotfix-10.1.
  • Create a merge request on Gitlab having the hotfix branch as source and the master branch as target.
  • Once all the bug fixes have been merged into the hotfix branch, update the version number in AC_INIT in configure.ac.
  • Update the PACKAGING file.
  • Update the debian/changelog file.
  • Merge the hotfix branch into master.
  • Add a new tag on Gitlab:
  • Create a new merge request on Gitlab having the hotfix branch as source and the develop branch as target.
  • Merge the hotfix branch into develop. There should be a conflict in the configure.ac file, because of the changed version number. Keep the one coming from develop. Other conflicts might occur.
  • Update the Template:Octopus_minor_version wiki templates.
  • Add the new release to the "Other releases in this series" section. There's no need to update the download links, this is done through the templates.
  • Update the Changes wiki page, referring to the merge requests on Gitlab.
  • Update the wiki Main_Page, so it shows this latest release.
  • Add the release to News on the Main_Page.