Skip to content

Commit 0b9ae84

Browse files
committed
updates release docs
Signed-off-by: Ashraf Fouda <ashraf.m.fouda@gmail.com>
1 parent 11a6d0a commit 0b9ae84

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/release.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# Branching
2+
3+
- Each release is developed on a branch that is derived from the development branch (e.g. development_2.0).
4+
- All pull requests should be made to this release branch; no commits should be made directly to the development branch.
5+
- The development branch should always reflect the latest release.
6+
- the release branch should go to development then to master.
17

28
# Release
39

@@ -21,7 +27,7 @@ let's say the next tag is `v1.0.0`, release will be:
2127

2228
- Create a tag `git tag -a grid-proxy/v1.0.0 -m "release grid-proxy/v1.0.0"`
2329
- Push the tag `git push origin grid-proxy/v1.0.0`
24-
For Further info check Grid-proxy release [docs](../grid-proxy/docs/release.md).
30+
For Further info check Grid-proxy release [docs](../grid-proxy/docs/release.md).
2531

2632
### RMB-sdk-go
2733

@@ -36,10 +42,11 @@ For Further info check Grid-proxy release [docs](../grid-proxy/docs/release.md).
3642
- the release workflow will release the tag automatically
3743

3844
## Tags Convention
45+
3946
The following convention should be followed for tagging in this project:
4047

4148
Release Tags: For release names and GitHub tags, the tag format should be prefixed with v0.0.0. For example, a release tag could be v1.2.3, where 1.2.3 represents the version number of the release.
4249

4350
Docker Image Tags: For generated Docker images, such as in the tfgridproxy component, the tag format should only include the tag number without the v prefix. For example, a Docker image tag could be 0.0.0, representing the specific version of the image.
4451

45-
Following this convention will help maintain consistency and clarity in tagging across all the grid components.
52+
Following this convention will help maintain consistency and clarity in tagging across all the grid components.

0 commit comments

Comments
 (0)