Skip to content

release v0.1 #71

@laurejt

Description

@laurejt

release prep

  • Pull updated copies of the develop and main branches
  • Update release version to appropriate number (for Python apps, set to final version without any -pre or -dev tags).
  • Use git flow to create a new release branch with the appropriate version (e.g., git flow release start 0.5)
  • Create a draft PR (since it should not be merged)
  • Update changelog to make sure that all features, changes, bugfixes, etc included in the release are documented. You may want to review the git revision history to be sure you’ve captured everything.
  • Review the README to make sure that its contents are up to date
  • Make sure local settings are documented (for django app: sample local settings file includes any new configurations).
  • Check python requirements for any internal dependencies that should be released (or at least pinned to a specific git commit)
  • Confirm that all GitHub Actions workflow checks are passing on the release branch (fix them if they are not)
  • Use git flow to finish the release (merge release branch into both main and develop, create a tag, remove the release branch, etc.). (git flow release finish 0.5)

after release

  • Increase the develop branch version so it is set to the next expected release (i.e., if you just released 0.5 then develop will probably be 0.6-dev unless you are working on a major update, in which case it will be 1.0-dev)
  • Push all updates to GitHub (main branch, develop branch, tags)
  • Clean up any release branches on GitHub

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions