Skip to content

Commit 688594a

Browse files
committed
Add a note that pulp-glue follows semver
1 parent f2a1e68 commit 688594a

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

pulp-glue/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# Pulp Glue
2-
## The version agnostic Pulp 3 client library in python
2+
## The version agnostic Pulp 3 client library in Python

pulp-glue/docs/dev/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to Pulp Glue
2+
3+
## The version agnostic Pulp 3 client library in Python
4+
5+
Pulp Glue is developed for and with the [Pulp CLI] in a combined repository.
6+
Therefore they share a common [changelog] and release corresponding versions.
7+
8+
## Versioning Policy
9+
10+
Pulp Glue follows semantic versioning (SemVer) compatibility.
11+
That is, with the one known exception that a new y-version does not necessarily imply a new feature to be available.
12+
This is a result from releasing in lock-step with `pulp-cli`.
13+
To stay compatible we advise to define the dependency as `pulp-glue=>x1.y1.z1,<x2.y2`.
14+
If you just want to avoid breaking changes, you can also settle on `pulp-glue=>x1.y1.z1,<x2`.
15+
16+
[Pulp CLI]: site:pulp-cli/
17+
[changelog]: site:pulp-cli/changes/

0 commit comments

Comments
 (0)