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

update release docs' #439

Merged
merged 2 commits into from
Oct 29, 2023
Merged

update release docs' #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52ada5f
update release docs'
rawdaGastan Oct 29, 2023
8009e4c
update proxy chart step
rawdaGastan Oct 29, 2023
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
5 changes: 5 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
release-rmb:
@echo "Release RMB..."
git tag -a "rmb-sdk-go/${VERSION}" -m "release rmb-sdk-go/${VERSION}" && \
git push origin rmb-sdk-go/${VERSION}

release:
@echo "Running release script..."
chmod +x release.sh
Expand Down
11 changes: 8 additions & 3 deletions docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@

# Release

- Update the helm app version for the grid proxy as described [here](../grid-proxy/docs/release.md)
- Create a pr against development branch to update the tfchain-client with the latest commit (make sure it's merged).
- Export `$VERSION` env variable to the version you want
- Run `make release-rmb`
- Update [zos](https://github.com/threefoldtech/zos) with the latest version of the rmb.
- Create a pr against development branch to update zos with the latest commit (make sure it's merged).
- Update the helm app version for the grid proxy as described [here](../grid-proxy/docs/release.md)
- Run `make release`

After all the release workflows are finished you should create an issue on <https://github.com/threefoldtech/tf_operations> with type of `Update Request` to use the new images/binaries.
Make sure to speicfy the new release version in the issue name and to include any changes in the usual release(like new configuration, etc,..)
Make sure to specify the new release version in the issue name and to include any changes in the usual release(like new configuration, etc,..)

## Release without script

Expand Down Expand Up @@ -36,10 +40,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.
1 change: 0 additions & 1 deletion release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ tag_and_push() {

tag_and_push "grid-client"
tag_and_push "grid-proxy"
tag_and_push "rmb-sdk-go"

# # main
git tag -a $VERSION -m "release $VERSION"
Expand Down