Adding python- tag related info the RELEASE.md

google · Dec 15, 2022 · 9151a8d · 9151a8d
1 parent 8a616b5
commit 9151a8d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/.github/workflows/python-publish-to-pypi.yaml b/.github/workflows/python-publish-to-pypi.yaml
@@ -1,12 +1,12 @@
-name: Publish to Pypi
+name: Publish Python to Pypi
 
 on:
   push:
     tags:
       - python-*
 
 jobs:
-  publish:
+  publish-python-to-pypi:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

diff --git a/python/sqlcommenter-python/RELEASE.md b/python/sqlcommenter-python/RELEASE.md
@@ -35,4 +35,6 @@ To publish a stable release:
 
 1. Do not change the release branch directly; make a PR to the release-X.Y branch with VERSION and any CHANGELOG changes.
 2. After merging your PR to release branch, `git tag` the new release from release branch.
-3. Merge the release branch `release-x.y` to `master`
+3. Tag should be prefixed with `python-`
+4. Once the release occurs `publish-python-to-pypi` workflow job will get executed and will publish the library to testpypi and pypi
+5. When build succeeds, merge the release branch `release-x.y` to `master`