automate PyPI publishing with GitHub Actions (#827)

+ version: replace version_num with version for easy re-use, and update its usage in __inti__.py

+ setup: use sys.path.append() to replace open() to grab version from version.py

+ add .github/workflows/publish-to-test-pypi.yml:
   - triggered for push event on insarlab/main branch
   - use "pip install" and "python -m build" to build the binary wheel and source tarball
   - use pypa/gh-action-pypi-publish action to push to PyPI and TestPyPI
   - push to PyPI only for released version and when owner is insarlab

+ repo setting: add github secrets from pypi, to support the above action

Author: yunjunz

.github/workflows/build-docker.yml

@@ -12,6 +12,7 @@ on:
 
 jobs:
   dockerize:
+    name: Build Docker image and push to GitHub Container Registry
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -31,7 +32,7 @@ jobs:
       - name: Set environment variables for docker build
         run: |
           # Lowercase repo for Github Container Registry
-          echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
+          echo "REPO=${GITHUB_REPOSITORY,,}" >> ${GITHUB_ENV}
           # Ensure tags are checked out
           git fetch origin +refs/tags/*:refs/tags/*
           # Version number from tag

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,58 @@
+# link: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+name: publish distributions 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+
+jobs:
+  build-n-publish:
+    if: github.repository_owner == 'insarlab'
+
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+
+    - name: Publish developed version 📦 to Test PyPI
+      if: github.ref == 'refs/heads/main'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+        skip_existing: false
+        verbose: true
+
+    - name: Publish released version 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags/v')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        verbose: true
+

mintpy/__init__.py

@@ -1,5 +1,5 @@
 # get version info
 from mintpy.version import (
-    version_num as __version__,
+    version as __version__,
     logo as __logo__,
 )

mintpy/version.py

@@ -67,9 +67,9 @@ def get_version_info():
 
 ###########################################################################
 
-version_num, version_date = get_version_info()
+version, version_date = get_version_info()
 version_description = """MintPy version {v}, date {d}""".format(
-    v=version_num,
+    v=version,
     d=version_date,
 )
 
@@ -90,7 +90,7 @@ def get_version_info():
    Miami InSAR Time-series software in Python    \______/ 
           MintPy {v}, {d}
 ___________________________________________________________
-""".format(v=version_num, d=version_date)
+""".format(v=version, d=version_date)
 
 website = 'https://github.com/insarlab/MintPy'
 

setup.py

@@ -5,26 +5,20 @@
 # Author: Zhang Yunjun, Nov 2020                           #
 ############################################################
 
-
+import os
+import sys
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
 
+# Grab version and description from version.py
+# link: https://stackoverflow.com/questions/53648900
+sys.path.append(os.path.dirname(__file__))
+from mintpy.version import version, description
 
-# Grab from README file: long_description
+# Grab long_description from README.md
 with open("docs/README.md", "r") as f:
     long_description = f.read()
 
-# Grab from version.py file: version and description
-with open("mintpy/version.py", "r") as f:
-    lines = f.readlines()
-    # version
-    line = [line for line in lines if line.strip().startswith("Tag(")][0].strip()
-    version = line.replace("'",'"').split('"')[1]
-    # description
-    line = [line for line in lines if line.startswith("description")][0].strip()
-    description = line.replace("'",'"').split('"')[1]
-
-
 setup(
     name="mintpy",
     version=version,