Publish a release

Publication procedure

  • Update merge request template (settings / merge_requests) to point to a new changelog wiki page

  • Update to point to new GitLab release

  • Create new web release page with generated artifact names (frontmatter only!)

  • Add a link to the (upcoming) Doxygen documentation for this tag in Documentation/ (with v-prefix)

  • Update [docs-release]-link in to the new tag (with v-prefix)

  • Add a redirect in scripts/doc/_redirects

  • Update CITATION.cff (Zenodo DOI will be added later)

  • Create a commit and push

  • Wait for CI to be green (except for URL checker which will fail)

  • Create a tag and push

    git tag -s -m "OpenGeoSys 6.5.0" 6.5.0
    git push --tags
  • A new release is automatically created on GitLab

    • Fill in the release notes from the Wiki
    • Convert MR ids to URLs: replace !([0-9][0-9][0-9][0-9]) with [!$1]($1) and #([0-9][0-9][0-9][0-9]) with [#$1]($1)
  • Copy release binaries and container images from CI job to Azure OGS storage to a subdirectory containing the tag name at

  • Create a release on GitHub mirror (ufz/ogs)

  • Check if a Zenodo release is automatically issued

  • Issue a scan on Software Heritage Archive

  • Update CITATION.cff and web/content/publications/ with new Zenodo DOI

  • Update CITATION.cff author list (git shortlog -sne 6.4.3...6.4.2) and corresponding bibtex-entry in publications web page

  • Update Zenodo entry with correct authors

  • Create bugfix branch

    • Create new netlify site (in an empty directory)
      • netlify init
      • # [ENTER]
      • # ogs-doxygen-v[TAG (- separated instead of .)]
    • Create branch from master with name v[TAG] and push
  • Create a discourse announcement post

    • DOI badge
    • Software heritage badge
    • Link to release page on
    • Link to GitLab release
    • Link to Zenodo release
    • Link to archive on Software Heritage
  • Set milestone on expired issues and merge requests

This article was written by Lars Bilke. If you are missing something or you find an error please let us know.
Generated with Hugo 0.122.0 in CI job 408829 | Last revision: January 12, 2024
Commit: [App|NodeWiseMeshPartitioner] Determine / append ghost nodes 8da02368  | Edit this page on