Skip to content

Commit aea9f05

Browse files
authored
Enhance README with version constraint recommendations
Added a section on version constraints for CI/CD usage, emphasizing the use of the Tilde Version Range Operator for stability.
1 parent a3262b5 commit aea9f05

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,21 @@ Download the latest release from the [GitHub releases page](https://github.com/d
172172

173173
You may also install the package globally using Composer:
174174
```shell
175-
composer global require --dev drevops/git-artifact
175+
composer global require --dev drevops/git-artifact:~1.1
176176
```
177177

178+
### 📌 Version constraint
179+
180+
When using `git-artifact` in CI/CD scripts, we recommend using **Tilde Version Range Operator** to ensure stability.
181+
The tilde constraint allows patch updates (e.g., `1.0.0``1.1.1`) but blocks minor version updates (e.g., `1.1.0``1.2.0`).
182+
183+
This ensures that:
184+
- **Security fixes and bug patches** are automatically applied
185+
- **CI/CD pipelines remain stable** - no unexpected breaking changes
186+
- **Minor version updates are blocked** - these may introduce behavioral changes that could affect deployments
187+
188+
This is especially important in CI/CD environments where deployment reliability is critical and changes should be tested before adoption.
189+
178190
## ▶️ Usage
179191

180192
```shell

0 commit comments

Comments
 (0)