Skip to content

Commit

Permalink
gitflow ch: just not releas branches not used; pkg maint ch: link to …
Browse files Browse the repository at this point in the history
…gitflow ch
  • Loading branch information
sckott committed Dec 4, 2024
1 parent 8c64baf commit c0d5734
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 5 deletions.
5 changes: 1 addition & 4 deletions gitflow.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,7 @@ gitGraph

There are formal tools for using a Gitflow model, e.g., [nvie/gitflow](https://github.com/nvie/gitflow). However, we aren't using that tool or any others at the moment.

There are components of Gitflow that we do not use right now, but could be used as needed:

- Release branches
- Hotfix branches
There is one component of Gitflow that we do not use right now: release branches.

## Further reading

Expand Down
2 changes: 1 addition & 1 deletion maintenance.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Overall the branching lifecycle can be summed up by the following:
4. Whenever project leads want to create a new release, they merge the `dev` branch into the `main` branch and tag a new release.
5. Urgent fixes to the `main` branch can be made by creating a branch from `main` that begins with the hotfix- prefix, which is then merged directly into `main` via pull request and code review. The `dev` branch will then be updated to reflect the changes on `main` via pull request. We should do our best to avoid this pattern. Since this changes the `main` branch, there will be a new tagged release.

We try to follow the principles set out in [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) with a few modifications:
We try to follow the principles set out in Gitflow (@sec-gitflow) with a few modifications:

- We use the `main` branch instead of the `master` branch, and we use the `dev` branch instead of the `develop` branch.
- We don’t use release branches, we create release tags from the `main` branch. Therefore we shouldn’t use the `release-` prefix at all.
Expand Down

0 comments on commit c0d5734

Please sign in to comment.