Skip to content

[rel] Release v0.3.0 #1

Description

@daniel-jettka

based on Edirom-Online Release Workflow

Release preparation timeline

  • create and plan next milestone (assign issues, set priorities, identify and name topic/s): link here
  • set dates for test phase:
  • set date for release:
  • send announcement about dates to community

Preparations on zenodo.org

  • go to previous version and click "New version"
  • reserve a DOI -> insert here
  • update version and other metadata in publication form
  • upload a placeholder file
  • save draft -> link here

Checkout develop branch: git checkout develop

  • have a look into release milestone and manage last issues and PRs
  • check third party dependencies

Checkout new release branch: git checkout -b release/vX.Y.Z develop

  • update CITATION.cff (date, contributors, version, DOI)
  • bump version number everywhere (find/replace in code), e.g. in build.xml
  • if applicable, update version number of backend/frontend in docker-compose.yml
  • commit version release branch
  • build .xar and test it

Checkout main branch: git checkout main

  • git merge --no-ff release/vX.Y.Z (release branch into main)
  • (potentially) resolve merge conflicts and git continue merge
  • git tag returns a list of all tags
  • git tag -a vX.Y.Z -m "vX.Y.Z"
  • (potentially) git tag for review
  • git push --follow-tags

Release on github.com

  • Go to tag vX.Y.Z and click "Release from Tag"
  • auto-generate the release description
  • upload the tested Edirom-Online-X.Y.Z.xar (asset)
  • publish the release on GitHub - link GitHub release

Checkout develop branch: git checkout develop

  • git merge --no-ff release/vX.Y.Z (release branch into develop)

Publication on zenodo.org

  • edit publication draft
  • remove placeholder file and upload files copied from GitHub release
  • double-check metadata
  • publish on Zenodo (with updated files) -> link publication DOI

Clean-up

  • delete branch release/vX.Y.Z
  • announce new version to Edirom-Online community

Plan next release

  • create new release issue

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions