Skip to content

Commit

Permalink
updates release docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ashraf Fouda <[email protected]>
  • Loading branch information
ashraffouda committed Jun 26, 2023
1 parent 11a6d0a commit 34ba294
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Branching

- Each release is developed on a branch that is derived from the development branch (e.g. development-2.0).
- All pull requests should be made to this release branch; no commits should be made directly to the development branch.
- The development branch should always reflect the latest release.
- the release branch should go to development then to master.

# Release

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

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

### RMB-sdk-go

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

## Tags Convention

The following convention should be followed for tagging in this project:

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.

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.

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

0 comments on commit 34ba294

Please sign in to comment.