Skip to content

Commit 7660e82

Browse files
Update release documentation
1 parent 29c9233 commit 7660e82

1 file changed

Lines changed: 10 additions & 13 deletions

File tree

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -262,9 +262,9 @@ Temporary branches conform to the following naming convention:
262262

263263
Use the following workflow when solving an issue:
264264

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

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

282282
When preparing for a release use the following workflow:
283283

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

298295
### Continuous integration
299296

0 commit comments

Comments
 (0)