ci: upload to TestPyPI only for (pre)releases (#11)

Author: hezean

.github/tools/check_metadata.py

@@ -0,0 +1,28 @@
+# Copyright 2022 FeatureProbe
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+import sys
+
+
+with open('featureprobe/__init__.py', 'r') as f:
+    content = f.read()
+    fmt = re.compile(r"__version__ = '(?P<version>.*)'")
+    version = fmt.search(content).groupdict()['version']
+
+tag = sys.argv[1].split('/')[-1]
+
+with open('featureprobe/__init__.py', 'w') as f:
+    version = "__version__ = '%s'" % tag
+    f.write(re.sub('__version__ = \'.*\'', version, content))

.github/workflows/codestyle.yml

@@ -40,7 +40,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       uses: EndBug/add-and-commit@v8.0.2
       with:
-        default_author: github_actions
+        default_author: github_actor
         message: "chore: add license header(s)"
 
     - name: Create pull request
@@ -73,5 +73,5 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       uses: EndBug/add-and-commit@v8.0.2
       with:
-        default_author: github_actions
+        default_author: github_actor
         message: "style: format python code (pep8)"

.github/workflows/release.yml

@@ -1,9 +1,10 @@
 name: "Release to PyPI & TestPyPI"
 
 on:
-  push:
-    branches: [ main ]
-
+  release:
+    types:
+      - released
+      - prereleased
 
 jobs:
   build-and-publish:
@@ -19,6 +20,20 @@ jobs:
         with:
           python-version: '3.5'
 
+      - name: Set the version metadata to the release tag
+        run: |
+          python .github/tools/check_metadata.py ${{ github.ref }}
+
+#      - name: PR for bumping version metadata
+#        uses: peter-evans/create-pull-request@v3
+#        with:
+#          author: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>
+#          commit-message: "chore: bump version metadata for ${{ github.ref }}"
+#          title: "chore: bump version metadata for ${{ github.ref }}"
+#          body: The version metadata was not updated before release, it has been corrected when building dist, yet please update the code.
+#          branch: bump-version
+#          base: ${{ github.event.release.target_commitish }}
+
       - name: Install dependencies
         run: |
           pip install --upgrade pip
@@ -36,7 +51,7 @@ jobs:
           repository_url: https://test.pypi.org/legacy/
 
       - name: Publish to PyPI
-        if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+        if: ${{ github.event.action }} == "released"
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -1,8 +1,6 @@
 name: "Tests"
 
 on:
-  push:
-    branches: [ main ]
   pull_request:
 
 concurrency:

featureprobe/__init__.py

@@ -15,7 +15,11 @@
 __author__ = 'FeatureProbe'
 __license__ = 'Apache 2.0'
 
-__version__ = '1.0.0-beta'
+
+# PEP440 spec:
+# [N!]N(.N)*[{a|b|rc}N][.postN][.devN]
+__version__ = 'NO_MANUAL_MAINTENANCE_NEEDED'
+
 
 # --------------- API --------------- #
 
@@ -39,8 +43,6 @@
 
 
 __all__ = [
-    '__version__',
-
     # featureprobe.model
 
     'Condition',

setup.py

@@ -34,9 +34,9 @@ def _requirements():
     'Programming Language :: Python :: 3.10',
 ]
 
-if 'alpha' in featureprobe.__version__:
+if 'a' in featureprobe.__version__:
     pypi_classifiers.append('Development Status :: 3 - Alpha')
-elif 'beta' in featureprobe.__version__:
+elif 'b' in featureprobe.__version__ or 'rc' in featureprobe.__version__:
     pypi_classifiers.append('Development Status :: 4 - Beta')
 else:
     pypi_classifiers.append('Development Status :: 5 - Production/Stable')