Skip to content

Update release documentation #7

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.

Sign up for GitHub

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

Open
johannes-graner wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update release documentation #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,9 @@ Temporary branches conform to the following naming convention:

Use the following workflow when solving an issue:

1. Make sure you are on the `develop` branch and that you have pulled all the
1. Make sure you are on the `main` branch and that you have pulled all the
latest changes to your local git repository.
2. Create a new temporary branch from the `develop` branch following the above
2. Create a new temporary branch from the `main` branch following the above
naming convention using e.g.

```sh
Expand All @@ -274,26 +274,23 @@ Use the following workflow when solving an issue:
3. Make and commit your changes to the temporary branch.
4. Push your temporary branch to the GitHub repository.
5. Open a pull request to merge the changes from your temporary branch into the
`develop` branch. Make sure to request at least one reviewer and mention
`main` branch. Make sure to request at least one reviewer and mention
which issue will be closed by this pull request.
6. After the changes have been accepted by the reviewer, merge the changes and
delete the temporary branch after merging.

When preparing for a release use the following workflow:

1. Make sure all intended changes are merged into `develop`.
2. Create a pull request to merge changes from `develop` into `acceptance` with all
1. Make sure all intended changes are merged into `main` and create a new branch
`release/vX.Y.X`.
2. Create a pull request to merge `release/vX.Y.Z` into `main` with all
current developers as reviewers.
3. Merge the changes after the review is accepted.
4. Test the current state of the repository thoroughly to make sure everything
works as intended. If any issues are found make the changes to the `develop`
branch and repeat step 2.
5. Create a pull request to merge `acceptance` into `master` with all current
developers as reviewers.
6. Merge the changes after the review is accepted.
7. Create a release on GitHub named `vX.Y.Z` according to semantic versioning
works as intended. If any issues are found make the changes to the `main`
branch and merge into `release/vX.Y.Z`.
5. Create a release on GitHub named `vX.Y.Z` according to semantic versioning
and tag the corresponding commit with the release tag.
8. Merge the release tag back into `develop` for continued development.
6. Merge the release tag back into `main` for continued development.

### Continuous integration

Expand Down