Test Release (#12)

* Allowing spec of major and minor version

* Adjusted value for github.base_ref

* Release Debugging

* Adjusted with updated workflow

* Combining test and coverage

Author: MrMatAP

.github/workflows/build.yml

@@ -1,5 +1,5 @@
 #
-# Main workflow to build
+# How to build this
 
 name: Build
 
@@ -13,12 +13,18 @@ env:
 
 #
 # Establish when the workflow is run
+# We do build on every push except when we push onto main (which we ought to be subject to branch protection)
+# We do build whenever a PR onto main is closed (see on) and the code is actually merged (see release job if)
+# Why is that okay?
+# Since we're making a PR, we know from the previous workflow run on push that the repo is okay and the PR
+# shows that to us. A PR itself doesn't cause a build, except when it is closed and the changes were merged.
 
 on:
   push:
-    branches-ignore:
-    - main
-  pull_request: {}
+    branches-ignore: [main]
+  pull_request_target:
+    branches: [main]
+    types: [closed]
 
 #
 # Workflow
@@ -29,13 +35,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - name: Pipeline Debugging
-      run: |
-        env
-
     - name: Checkout out our code
       uses: actions/checkout@v2
 
+    - name: Calculate Build Context
+      run: |
+        MRMAT_VERSION="${MAJOR}.${MINOR}.${GITHUB_RUN_NUMBER}"
+        if [ "$GITHUB_EVENT_NAME" == 'pull_request' ]; then
+          MRMAT_IS_RELEASE=true
+          echo "::warning ::Building release ${MRMAT_VERSION}"
+          echo "MRMAT_IS_RELEASE=true" >> $GITHUB_ENV
+        else
+          MRMAT_VERSION="${MRMAT_VERSION}.dev0"
+          echo "::warning ::Building version ${MRMAT_VERSION}"
+        fi
+        echo "MRMAT_VERSION=${MRMAT_VERSION}" >> $GITHUB_ENV
+
     - name: Set up Python ${{ env.PYTHON_VERSION }}
       uses: actions/setup-python@v2
       with:
@@ -54,25 +69,27 @@ jobs:
         pip install --user -r requirements.txt
         pip install --user -r test-requirements.txt
 
-    - name: Lint
+    - name: Test
       run: |
         flake8 --statistics
         pylint mrmat_python_api_flask
-
-    - name: Test
-      run: |
         python ./setup.py install
         python -m pytest
 
     - name: Upload test results
       uses: actions/upload-artifact@v2
       if: ${{ always() }}
       with:
-        name: tests
-        path: build/junit.xml
-
-    - name: Upload coverage
-      uses: actions/upload-artifact@v2
+        name: Test and Coverage
+        path: |
+          build/junit.xml
+          build/coverage.xml
+
+    - name: Conditional Release
+      uses: marvinpinto/action-automatic-releases@latest
+      if: github.event.pull_request.merged == true
       with:
-        name: coverage
-        path: build/coverage.xml
+        repo_token: "${{ secrets.GITHUB_TOKEN }}"
+        automatic_release_tag: "${{ env.MRMAT_VERSION }}"
+        prerelease: false
+        title: "Release ${{ env.MRMAT_VERSION }}"

README.md

@@ -19,12 +19,9 @@ This variant of a Python Flask API is code-first and using native Flask
 
 ## How to build this
 
-Use the standard `python ./setup.py install` to build. There are two environment variables that influence the build
-
-| Environment Variable | Default | Description |
-|----------------------|---------|-------------|
-| IS_RELEASE           | <unset> | If unset, `.dev0` is appended to the version being built, otherwise an empty string |
-| GITHUB_RUN_NUMBER    | 0       | Determines the micro version. If unset, the micro number is 0 |
+Use the standard `python ./setup.py install` to build. By default, the version built will be `0.0.0.dev0`,
+unless the `MRMAT_VERSION` environment variable is set by the build orchestrator (e.g. GitHub Actions). The
+version and whether a release is built is consequently controlled exlusively by the build orchestrator.
 
 ## How to run this
 

setup.py

@@ -23,19 +23,9 @@
 import os
 from setuptools import setup, find_packages
 
-#
-# Construct the version
-# If we are running in the context of a GitHub action then we use the GITHUB_RUN_NUMBER
-# otherwise we will default to 0 for the micro version.
-
-major = os.environ['MAJOR'] if 'MAJOR' in os.environ else 0
-minor = os.environ['MINOR'] if 'MINOR' in os.environ else 0
-micro = os.environ['GITHUB_RUN_NUMBER'] if 'GITHUB_RUN_NUMBER' in os.environ else 0
-dev = '.dev0' if 'IS_RELEASE' not in os.environ else ''
-
 setup(
     name='mrmat-python-api-flask',
-    version=f'{major}.{minor}.{micro}{dev}',
+    version=os.environ['MRMAT_VERSION'] if 'MRMAT_VERSION' in os.environ else '0.0.0.dev0',
     packages=find_packages(),
     license='MIT',
     author='MrMat',