Skip to content

Commit 8424c4c

Browse files
committed
docs: update release process documentation in README
1 parent 6d279e9 commit 8424c4c

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,27 @@ make secure
7474
```
7575

7676
## Release Process
77-
1. Create PR against `develop`
78-
2. After approval and CI passing, merge to `develop`
79-
3. Create release branch `vX.X.XX`
80-
4. After testing, merge to `master` and `develop`
81-
5. Tag the release
82-
6. Push changes and tags
83-
7. Verify release artifacts in GitHub
77+
1. Create feature branch from `main`
78+
2. Create PR against `main`
79+
3. After approval and CI passing, merge to `main`
80+
4. Create a new release either:
81+
- Through GitHub UI:
82+
1. Go to "Releases" on GitHub
83+
2. Click "Draft a new release"
84+
3. Create a new tag (e.g., v0.5.2)
85+
4. Fill in release details
86+
5. Click "Publish release"
87+
- Or via command line:
88+
```bash
89+
git tag vX.X.X
90+
git push origin vX.X.X
91+
```
92+
5. The GitHub Action will automatically:
93+
- Build the provider
94+
- Create a GitHub release
95+
- Publish to the Terraform Registry
96+
97+
Note: Tags should follow semantic versioning (e.g., v0.5.2)
8498

8599
## Terraform Overview
86100
Terraform enables declarative infrastructure management using HashiCorp Configuration Language (HCL). It tracks the desired state in `.tf` files and the current state in `.tfstate` files.

0 commit comments

Comments
 (0)