Skip to content

Commit

Permalink
[docs] update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cuongpiger committed May 2, 2024
1 parent 0379373 commit d32a9f5
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,24 @@
**RELEASE** - [![Release vngcloud-blockstorage-csi-driver project](https://github.com/vngcloud/vngcloud-blockstorage-csi-driver/actions/workflows/release.yml/badge.svg)](https://github.com/vngcloud/vngcloud-blockstorage-csi-driver/actions/workflows/release.yml)

<hr>

# Contributing
## Development
- For the **development** purpose, this project uses the `dev` branch to deploy and build the image. Followings are the steps to build and push new images to VngCloud Registry:
```bash
# Make sure you are on the `dev` branch
git add .
git commit -am "[build] This is a really spectacular feature for this plugin"
git push
```

## Production
- The branch `main` is used to trigger the release workflow via GitHub actions. To deploy your new code as the latest stable version, follow these steps:
```bash
# Make sure you are on the `main` branch
git add .
git commit -am "[release] This is a really spectacular feature for this plugin"
git tag -am "[release] This is a really spectacular feature for this plugin" v1.0.0
git push --tags
```
- The above steps also trigger to create a new **Release** in GitHub.

0 comments on commit d32a9f5

Please sign in to comment.