Skip to content

Commit b05a370

Browse files
authored
Add release instructions to README.md
1 parent 62bdbce commit b05a370

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,26 @@ If you would rather use `debricked` in your CI/CD pipelines, check out the [temp
8686
## Contributing
8787
Thank you for your interest in making Debricked CLI even better! Read more about contributing to the
8888
project [here](CONTRIBUTING.md).
89+
90+
## Releasing
91+
1. Go to the [releases page](https://github.com/debricked/cli/releases), press [Draft a new release](https://github.com/debricked/cli/releases/new).
92+
93+
2. Create a new tag. We loosely use semantic versioning for our versions.
94+
- Major releases should only be used for major breaking changes.
95+
- Minor releases should be used for minor breaking changes and new major features.
96+
- Patch releases should be used for smaller improvements, bug fixes etc. No breaking changes are allowed in these.
97+
98+
2a. IF you released a major version. The following needs to be done:
99+
- For a major, a upgrade document needs to be provided like we did for the [2.0 release](https://github.com/debricked/cli/blob/main/UPGRADE-2.0.md).
100+
- Our GitHub actions need to be updated accordingly. Like was done [in this commit](https://github.com/debricked/actions/commit/659ae7accc12313772fbfbd1b1fccec31772ce41) for the v1 -> v2 upgrade.
101+
- Users need to be informed that a new major version is available and that they should upgrade.
102+
- [All integration templates](https://github.com/debricked/cli/tree/main/examples/templates) needs to be updated to use the new major version.
103+
- Our documentation needs to be updated to use the new major version.
104+
105+
3. After having created a new tag in the New release dialogue. Press `Generate release notes` to get some sane default notes. Adjust if necessary. It will look something like this:
106+
107+
![image](https://github.com/user-attachments/assets/7e1511ea-efad-49d4-a4eb-8ee762dcd1b2)
108+
109+
4. When satisfied, press `Publish release`.
110+
111+

0 commit comments

Comments
 (0)