Skip to content

Commit f3b5af6

Browse files
committed
Update developer guide and define versioning strategy
1 parent 8e94258 commit f3b5af6

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
tags:
66
- v[0-9]+.[0-9]+.[0-9]+
7-
- v[0-9]+.[0-9]+.[0-9]+.alpha[0-9]+
7+
- v[0-9]+.[0-9]+.[0-9]+.post[0-9]+
88
- v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+
99

1010
jobs:

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,15 @@ if __name__ == '__main__':
103103
main()
104104
```
105105

106+
## Versioning
107+
108+
Fluid Python SDK's version **ALWAYS** follows the Fluid's version as long as they share the fully compatible APIs. For example, if a released version of Fluid is v1.0.1, Fluid Python SDK with version prefix "v1.0.1" is guaranteed to have
109+
same APIs as the released Fluid version.
110+
111+
Fluid Python SDK may have "post" version that updates the inner code but keep the APIs untouched (e.g. hotfixes). For example, "v1.0.1.post1" is a post version of "v1.0.1" which includes the latest
112+
changes.
113+
114+
106115
## Documentation For Models
107116

108117
- [APIGatewayStatus](docs/APIGatewayStatus.md)

fluid/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
from __future__ import absolute_import
1515

16-
__version__ = "0.1.2"
16+
__version__ = "1.0.2"
1717

1818
# import apis into sdk package
1919

hack/develop/developer_guide.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,18 @@ Now starts the Python interpreter and you can import the SDK:
6969
7070
4. Cut a release and publish it to PyPi
7171
72-
Similarly, to cut a release and publish it to PyPi, tag the latest commit with `vX.Y.Z` and use `git push --tags` to
72+
Similarly, to cut a release and publish it to PyPi, tag the latest commit with `vX.Y.Z` or `vX.Y.Z.postN`(See [Versioning](../../README.md#Versioning)) and use `git push --tags` to
7373
trigger
7474
a [GitHub Workflow](https://github.com/fluid-cloudnative/fluid-client-python/blob/master/.github/workflows/release.yml)
7575
to automatically build and publish the package to PyPi.
7676
For example:
7777
```
78+
# first release (compatible APIs with Fluid v1.0.1)
7879
git tag v1.0.1
80+
81+
# second release (compatible APIs with Fluid v1.0.1)
82+
git tag v1.0.1.post1
83+
7984
git push --tags origin
8085
```
8186

0 commit comments

Comments
 (0)