diff --git a/docs/release.md b/docs/release.md index 2e0d0b05f..fe4a32f6f 100644 --- a/docs/release.md +++ b/docs/release.md @@ -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 @@ -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 @@ -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. \ No newline at end of file +Following this convention will help maintain consistency and clarity in tagging across all the grid components.