Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of Release Workflow #21

Open
3 tasks
geoffreygarrett opened this issue Feb 15, 2023 · 0 comments
Open
3 tasks

Documentation of Release Workflow #21

geoffreygarrett opened this issue Feb 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@geoffreygarrett
Copy link
Member

geoffreygarrett commented Feb 15, 2023

Description

This issue is to document the release workflow in the developer documentation. At the core of the release workflow, the GitFlow release model has been adopted. Once the develop branch has acquired enough features for a release (or a predetermined release date is approaching), a release branch should be forked off of develop. This branch should only contain bug fixes, documentation generation, and other release-oriented tasks. Once it's ready to ship, the release branch gets merged into main and tagged with a version number. In addition, it should be merged back into develop, which may have progressed since the release was initiated. This general workflow with all details and explanations will be documented.

Checklist

Additional Information [source]

  • Using a dedicated branch to prepare releases makes it possible for one team to polish the current release while another team continues working on features for the next release.
  • Release branches are based on the develop branch.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: tudat-developer-docs
Development

No branches or pull requests

1 participant