Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix table formatting #103

Merged
merged 1 commit into from
Jun 3, 2024
Merged

Fix table formatting #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions git-branching-merging.qmd
View file
Open in desktop
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
Loading