Skip to content

Commit 8488d4e

Browse files
authored
update readme with release notes (#3)
1 parent 27aeeef commit 8488d4e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# INFO
2+
3+
This repo is Sync's fork of https://github.com/databricks/databricks-sdk-py/. It allows Sync to pull in commits / feature or create contributions to upstream that enhance both Sync's product offering and the Databricks ecosystem.
4+
5+
This repo is *public*.
6+
7+
To release this repo:
8+
9+
1. Locally (on your terminal) tag the commit you want to release with a version for example: git tag v0.0.29-sync.0
10+
2. Push this tag git push origin v0.0.29-sync.0
11+
3. Pushing the tag triggers an automated github action that looks for tags that start with v: https://github.com/synccomputingcode/databricks-sdk-py/blob/main/.github/workflows/release.yml#L6
12+
4. The actions run in github and create a draft release, with the release artifacts tied to it. https://github.com/synccomputingcode/databricks-sdk-py/releases/tag/untagged-327af053f51d1f4da444
13+
5. To make the release "real", edit it and publish it
14+
6. Then bump this the dependency inside of sync's codebase
15+
116
# Databricks SDK for Python (Beta)
217

318
[![PyPI - Downloads](https://img.shields.io/pypi/dw/databricks-sdk)](https://pypistats.org/packages/databricks-sdk)

0 commit comments

Comments
 (0)