Skip to content

Commit

Permalink
Fix table formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Bisaloo committed Jun 3, 2024
1 parent 3db5293 commit bdbc252
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions git-branching-merging.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,27 @@ Two development strategies are common:

The R community in general sticks with a simple feature branch flow, and doesn't use a development branch. Most developers and users assume that the main GitHub version can be somewhat unstable and that stable releases are on CRAN.

+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| | GitHub Flow | Git Flow |
+======================================================================================================================================+=============================================================================+=================================================================================+
| feature | 1 long-running branch | 2 long-running branches |
+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| characteristic | - **stable** released version | - **stable** `main` branch, and |
| | - **unstable** `main` branch (development version) | - **unstable** `development` branch; |
| | - many feature branches originating from and being merged into `main` | - many feature branches originating from and being merged into `development` |
+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| installation instructions | The **real** package can be installed from CRAN with: | The **real** package can be installed from CRAN with: |
| | `install.packages("real")` | `install.packages("real")` |
| | You can also choose to install the development version of real from GitHub: | You can also choose to install the development version of real from GitHub: |
| | `remotes::install_github("epiverse-trace/real")` | `remotes::install_github("epiverse-trace/real@dev")` |
+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| | GitHub Flow | Git Flow |
+========================================================================================================================================+=============================================================================+=================================================================================+
| feature | 1 long-running branch | 2 long-running branches |
+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| characteristic | - **stable** released version | - **stable** `main` branch, and |
| | - **unstable** `main` branch (development version) | - **unstable** `development` branch; |
| | - many feature branches originating from and being merged into `main` | - many feature branches originating from and being merged into `development` |
+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| installation instructions | The **real** package can be installed from CRAN with: | The **real** package can be installed from CRAN with: |
| | `install.packages("real")` | `install.packages("real")` |
| | You can also choose to install the development version of real from GitHub: | You can also choose to install the development version of real from GitHub: |
| | `remotes::install_github("epiverse-trace/real")` | `remotes::install_github("epiverse-trace/real@dev")` |
+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| use of the [**pkgdown** development mode](https://pkgdown.r-lib.org/reference/build_site.html#development-mode) to build two websites: | in the `_pkgdown.yml` file: | A custom `pkgdown.yml` GitHub Actions workflow setting the development mode to: |
| | | |
| - released **stable** version | ``` yaml | - `dev` when triggered from the `development` branch |
| - development **unstable** version | development: | - `release` when triggered from the `main` branch |
| | mode: auto | |
| | ``` | |
+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| | | |
| - released **stable** version | ``` yaml | - `dev` when triggered from the `development` branch |
| - development **unstable** version | development: | - `release` when triggered from the `main` branch |
| | mode: auto | |
| | ``` | |
+----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+

At the time of writing this chapter, the [`@epiverse-trace/lac` team](https://github.com/orgs/epiverse-trace/teams/lac) team uses a branching process inspired from Git Flow and the [`@epiverse-trace/lshtm-mrcg` team](https://github.com/orgs/epiverse-trace/teams/lshtm-mrcg) uses a workflow inspired from the GitHub Flow.

Expand Down

0 comments on commit bdbc252

Please sign in to comment.