From c0d57342d1199c33d443bdeb6775e360b45186e6 Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Wed, 4 Dec 2024 12:24:49 -0800 Subject: [PATCH] gitflow ch: just not releas branches not used; pkg maint ch: link to gitflow ch --- gitflow.qmd | 5 +---- maintenance.qmd | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/gitflow.qmd b/gitflow.qmd index 779a374..e3edcd7 100644 --- a/gitflow.qmd +++ b/gitflow.qmd @@ -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 diff --git a/maintenance.qmd b/maintenance.qmd index 80caf46..33af8b7 100644 --- a/maintenance.qmd +++ b/maintenance.qmd @@ -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.