Fiddle around with CI/CD #7

Author: Ickerday

.github/workflows/release.yml

@@ -5,18 +5,21 @@ on:
 
 jobs:
   publish:
-    name: Deploy Release to PyPI
+    name: Deploy release to PyPI
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout source
+      - name: Checkout source code
         uses: actions/checkout@v3
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: 3.9
       - name: Install dependencies
         run: pip install .
+        # [BJ] Shouldn't we run tests here to prevent an easily preventable catastrophe?
+        #      Or is test.yml being ran when we publish a package?
       - name: Build package
+        # [TODO] We need to confirm this produces the same exact result as `python setup.py sdist`
         run: python -m build
       - name: Publish package to PyPI
         uses: pypa/[email protected]
@@ -27,7 +30,7 @@ jobs:
         run: |
           rm -rf ./docs/_build
           tox -e docs
-      - name: Docs Upload
+      - name: Upload docs
         uses: actions/upload-artifact@v3
         with:
           name: python_sdk_docs
@@ -37,5 +40,5 @@ jobs:
       #   uses: pypa/gh-action-pypi-publish@master
       #   with:
       #     user: __token__
-      #     password: ${{ secrets.test_pypi_password }}
+      #     password: ${{ secrets.TEST_PYPI_PASSWORD }}
       #     repository_url: https://test.pypi.org/legacy/

.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - name: Checkout code
+      - name: Checkout source code
         uses: actions/checkout@v3
       - name: Set up .env
         run: cp ./.env.template ./.env
@@ -41,7 +41,7 @@ jobs:
         run: pip install .
       - name: Run test suite
         run: tox -e py
-
-  # fossa-scan:
-  #   uses: splunk/oss-scanning-public/.github/workflows/oss-scan.yml@main
-  #   secrets: inherit
+# [BJ] I'll obviously uncomment this step after I finish fiddling
+# fossa-scan:
+#   uses: splunk/oss-scanning-public/.github/workflows/oss-scan.yml@main
+#   secrets: inherit