Skip to content

Commit

Permalink
chore(doc): add gitflow doc to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vbeaucha committed Aug 18, 2023
1 parent c4008de commit 20dd2d3
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,51 @@ git sparse-checkout set "deploy" "APP"
# branch you wish to checkout
git pull origin main
```


# 🔁 OGree-Core GitFlow

![Workflows diagram](/assets/images/main.jpg)

## Release candidate

After merging a dev branch on main, workflows will create a new branch name `release-candidate/x.x.x`.

Semver bump are define by the following rules:
- One commit between last tag and main contains: break/breaking -> Bump major version
- One commit between last tag and main contains: feat/features -> Bump minor version
- Any other cases -> Bump patch version

if a branch release-candidate with the same semver already exists, it will be deleted and recreated from the new commit. ( If a new fix is merge after an other how has not been released by example )

## Release

After validate a release candidate, a manual workflow named `📦 Create Release` can be called form github actions panel on the release-candidate branch and will create a `release/x.x.x branch`

![Github Actions panel](/assets/images/github.png)

Note: If release workflow is launch on another branch when a release-candidate, it will fail.

## Build docker images and CLI

### Docker images
When a branch release-candidate or release are created, Build Docker workflow are trigger.

It will create and push docker image, tags with semver, on private docker registry `registry.ogree.ditrit.io`

Docker iamges created are:
- mongo-api/x.x.x: image provide by API/Dockerfile
- ogree-app/x.x.x: image provide by APP/Dockerfile


### CLI

CLI will be build and push into ogree nextcloud folder `/bin/x.x.x/`

### Sermver for docker images and CLI

If build workflow is trigger by a release-candidate branch, workflow will add `.rc` after semver

- release-candidate/1.0.0 will made mongo-api/1.0.0.rc by example

If build workflow is trigger by a release bracnh, workflow will tag OGree-Core with semver
Binary file added assets/images/github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/main.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 20dd2d3

Please sign in to comment.