bdverse-dev-guide/devops_git.Rmd at master · bd-R/bdverse-dev-guide · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#  (PART) DevOps {-}
 <!-- PART 2: DevOps -->

# Git & GitHub Strategy

## Our needs

Synchronizing the perpetual development and releases of many R packages is challenging; nevertheless, when they have a strict hierarchical dependency architecture. Fully embracing [Git best practices](https://happygitwithr.com/) is crucial to our well being (i.e., crucial to project longevity).

## Our Git strategy
[**Under Construction**]

Having a clear, robust, consistent, and well-documented branching strategy is the key. We are more or less following the [Gitflow Workflow](https://nvie.com/posts/a-successful-git-branching-model):

From: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

### `master` & `dev`
![Develop and Master Branches](https://wac-cdn.atlassian.com/dam/jcr:2bef0bef-22bc-4485-94b9-a9422f70f11c/02%20(2).svg?cdnVersion=1208)

### Feature branches: pros & cons
![Feature Branches](https://wac-cdn.atlassian.com/dam/jcr:b5259cce-6245-49f2-b89b-9871f9ee3fa4/03%20(2).svg?cdnVersion=1208)


### Multi-packages release: `bdverse` is the key
![Release Branches](https://wac-cdn.atlassian.com/dam/jcr:a9cea7b7-23c3-41a7-a4e0-affa053d9ea7/04%20(1).svg?cdnVersion=1208)


## Adjustments to working with GitHub
[**Under Construction**]

The [Github Flow](https://medium.com/@patrickporto/4-branching-workflows-for-git-30d0aaee7bf#a5c2) is somewhat different...

### `master` is the defult branch, why?

## Versioning
[**Under Construction**]

https://semver.org/

![Semantic Versioning](https://pbs.twimg.com/media/Eb3aLbuWoAA0fKn?format=png&name=900x900)