Merge pull request #138 from fyntex/feature/upload-to-pypi-from-ci

config: Add PyPI package uploading to CI

Author: jtrh

.circleci/config.yml

@@ -11,6 +11,22 @@
 #
 version: "2.1"
 
+# -----BEGIN Environment Variables-----
+
+# Environment variables required for deployment:
+#
+# - PYPI_PASSWORD := PyPI password or API token.
+# - PYPI_USERNAME := PyPI username. For API tokens, use "__token__".
+# - TWINE_NON_INTERACTIVE := Do not interactively prompt for credentials if they are missing.
+# - TWINE_REPOSITORY_URL := The repository (package index) URL to register the package to.
+
+# x-deploy-environment := Deployment environment variables
+x-deploy-environment: &x-deploy-environment
+  TWINE_NON_INTERACTIVE: "true"
+  TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/
+
+# -----END Environment Variables-----
+
 jobs:
   test:
     parameters:
@@ -95,6 +111,35 @@ jobs:
           path: dist
           destination: dist
 
+      - persist_to_workspace:
+          root: ~/repo
+          paths:
+            - dist
+            - venv
+
+  deploy:
+    docker:
+      - image: python:3.7.2
+        environment:
+          <<: *x-deploy-environment
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - attach_workspace:
+          at: ~/repo
+
+      - deploy:
+          name: Upload Artifacts to Repository
+          command: |
+            . venv/bin/activate
+
+            make upload-release \
+              TWINE_USERNAME="${PYPI_USERNAME:?}" \
+              TWINE_PASSWORD="${PYPI_PASSWORD:?}"
+
 workflows:
   version: 2
   ci:
@@ -107,3 +152,10 @@ workflows:
                 - "3.7.6"
                 - "3.8.3"
       - dist
+      - deploy:
+          requires:
+            - dist
+          filters:
+            branches:
+              only:
+                - master

docs/project-maintenance.rst

@@ -95,6 +95,9 @@ Push commit ``abcd1234`` and tag ``vX.Y.Z`` automatically created by ``bumpversi
 4) Publish to PyPI
 +++++++++++++++++++
 
+.. warning::
+  Only perform this step if the CI system failed to upload the package.
+
 (local workstation)
 
 Run::