Package/PublishOnPyPI: choose source distribution and wheel separately (#319)

Author: Paebbels

.github/workflows/CompletePipeline.yml

@@ -177,6 +177,16 @@ on:
         required: false
         default: 'true'
         type: string
+      package_sdist:
+        description: "If 'true', build a source distribution (*.tar.gz)."
+        required: false
+        default: 'true'
+        type: string
+      package_wheel:
+        description: "If 'true', build a wheel (*.whl)."
+        required: false
+        default: 'true'
+        type: string
       pypi_url:
         description: 'Base URL of the package registry, which is checked for an existing release.'
         required: false
@@ -192,6 +202,16 @@ on:
         required: false
         default: 'false'
         type: string
+      pypi_publish_sdist:
+        description: "If 'true', publish the source distribution (*.tar.gz). Default changes to 'false' with @r10."
+        required: false
+        default: 'true'
+        type: string
+      pypi_publish_wheel:
+        description: "If 'true', publish the wheel (*.whl)."
+        required: false
+        default: 'true'
+        type: string
       cleanup:
         description: 'Cleanup artifacts afterwards.'
         required: false
@@ -334,6 +354,8 @@ jobs:
     with:
       python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
       artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+      package_sdist:  ${{ inputs.package_sdist }}
+      package_wheel:  ${{ inputs.package_wheel }}
 
   Install:
     uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@dev
@@ -556,6 +578,8 @@ jobs:
       dry_run:         ${{ inputs.pypi_dry_run }}
       pypi_upload_url: ${{ inputs.pypi_upload_url }}
       pypi_compliant:  ${{ needs.Package.outputs.pypi_compliant }}
+      publish_sdist:   ${{ inputs.pypi_publish_sdist }}
+      publish_wheel:   ${{ inputs.pypi_publish_wheel }}
       cleanup:         ${{ inputs.cleanup }}
     secrets:
       PYPI_TOKEN:      ${{ secrets.PYPI_TOKEN }}

.github/workflows/Package.yml

@@ -44,6 +44,16 @@ on:
         description: 'Name of the package artifact.'
         required: true
         type: string
+      package_sdist:
+        description: "If 'true', build a source distribution (*.tar.gz)."
+        required: false
+        default: 'true'
+        type: string
+      package_wheel:
+        description: "If 'true', build a wheel (*.whl)."
+        required: false
+        default: 'true'
+        type: string
 
     outputs:
       pypi_compliant:
@@ -78,11 +88,11 @@ jobs:
         run: python -m pip install --disable-pip-version-check build
 
       - name: 🔨 [build] Build Python package (source distribution)
-        if: inputs.requirements == ''
+        if: inputs.requirements == '' && inputs.package_sdist == 'true'
         run: python -m build --sdist
 
       - name: 🔨 [build] Build Python package (binary distribution - wheel)
-        if: inputs.requirements == ''
+        if: inputs.requirements == '' && inputs.package_wheel == 'true'
         run: python -m build --wheel
 
       # build (not isolated)
@@ -92,11 +102,11 @@ jobs:
         run: python -m pip install --disable-pip-version-check build
 
       - name: 🔨 [build - no-isolation] Build Python package (source distribution)
-        if: inputs.requirements == 'no-isolation'
+        if: inputs.requirements == 'no-isolation' && inputs.package_sdist == 'true'
         run: python -m build --no-isolation --sdist
 
       - name: 🔨 [build - no-isolation] Build Python package (binary distribution - wheel)
-        if: inputs.requirements == 'no-isolation'
+        if: inputs.requirements == 'no-isolation' && inputs.package_wheel == 'true'
         run: python -m build --no-isolation --wheel
 
       # setuptools
@@ -106,11 +116,11 @@ jobs:
         run: python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
 
       - name: 🔨 [setuptools] Build Python package (source distribution)
-        if: inputs.requirements != '' && inputs.requirements != 'no-isolation'
+        if: inputs.requirements != '' && inputs.requirements != 'no-isolation' && inputs.package_sdist == 'true'
         run: python setup.py sdist
 
       - name: 🔨 [setuptools] Build Python package (binary distribution - wheel)
-        if: inputs.requirements != '' && inputs.requirements != 'no-isolation'
+        if: inputs.requirements != '' && inputs.requirements != 'no-isolation' && inputs.package_wheel == 'true'
         run: python setup.py bdist_wheel
 
       - name: 🩺 Inspect packages for PyPI compliance

.github/workflows/PublishOnPyPI.yml

@@ -64,6 +64,16 @@ on:
         required: false
         default: 'true'
         type: string
+      publish_sdist:
+        description: "If 'true', publish the source distribution (*.tar.gz). Default changes to 'false' with @r10."
+        required: false
+        default: 'true'
+        type: string
+      publish_wheel:
+        description: "If 'true', publish the wheel (*.whl)."
+        required: false
+        default: 'true'
+        type: string
     secrets:
       PYPI_TOKEN:
         description: "Token for pushing releases to PyPI"
@@ -81,7 +91,7 @@ jobs:
           name: ${{ inputs.artifact }}
           path: dist
 
-      - name: 🔍 Check that the package is PyPI-compliant
+      - name: 🕵️ Check that the package is PyPI-compliant
         if: inputs.pypi_compliant == 'false'
         run: |
           ANSI_LIGHT_RED=$'\x1b[91m'
@@ -107,19 +117,28 @@ jobs:
       - name: ⚙ Install dependencies for packaging and release
         run: python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
 
-      - name: 🔎 Check Python packages instead of publishing them
-        if: inputs.dry_run == 'true'
-        run: twine check dist/*.whl dist/*.tar.gz
+      - name: 🩺 Check Python wheel package instead of publishing it
+        if: inputs.dry_run == 'true' && inputs.publish_wheel == 'true'
+        run: twine check dist/*.whl
+
+      - name: 🩺 Check Python source package instead of publishing it
+        if: inputs.dry_run == 'true' && inputs.publish_sdist == 'true'
+        run: twine check dist/*.tar.gz
+
+      - name: ⚠ Nothing selected for publishing
+        if: inputs.publish_wheel != 'true' && inputs.publish_sdist != 'true'
+        run: |
+          printf -- "::warning title=PublishOnPyPI::Nothing published or checked: 'publish_wheel' and 'publish_sdist' are both 'false'.\n"
 
       - name: ⤴ Publish Python wheel package to PyPI
-        if: inputs.dry_run != 'true'
+        if: inputs.dry_run != 'true' && inputs.publish_wheel == 'true'
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
         run: twine upload --repository-url "${{ inputs.pypi_upload_url }}" dist/*.whl
 
       - name: ⤴ Publish Python source package to PyPI
-        if: inputs.dry_run != 'true'
+        if: inputs.dry_run != 'true' && inputs.publish_sdist == 'true'
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}

doc/JobTemplate/AllInOne/CompletePipeline.rst

@@ -589,6 +589,10 @@ Parameter Summary
 +--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
 | :ref:`JOBTMPL/CompletePipeline/Input/check_pypi_duplicate`         | no       | string | ``'true'``                                                                 |
 +--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
+| :ref:`JOBTMPL/CompletePipeline/Input/package_sdist`                | no       | string | ``'true'``                                                                 |
++--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
+| :ref:`JOBTMPL/CompletePipeline/Input/package_wheel`                | no       | string | ``'true'``                                                                 |
++--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
 | :ref:`JOBTMPL/CompletePipeline/Input/pypi_url`                     | no       | string | ``'https://pypi.org'``                                                     |
 +--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
 | :ref:`JOBTMPL/CompletePipeline/Input/apptest_python_version_list`  | no       | string | ``''``                                                                     |
@@ -615,6 +619,10 @@ Parameter Summary
 +--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
 | :ref:`JOBTMPL/CompletePipeline/Input/pypi_dry_run`                 | no       | string | ``'false'``                                                                |
 +--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
+| :ref:`JOBTMPL/CompletePipeline/Input/pypi_publish_sdist`           | no       | string | ``'true'``                                                                 |
++--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
+| :ref:`JOBTMPL/CompletePipeline/Input/pypi_publish_wheel`           | no       | string | ``'true'``                                                                 |
++--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
 | :ref:`JOBTMPL/CompletePipeline/Input/pypi_upload_url`              | no       | string | ``'https://upload.pypi.org/legacy/'``                                      |
 +--------------------------------------------------------------------+----------+--------+----------------------------------------------------------------------------+
 | :ref:`JOBTMPL/CompletePipeline/Input/cleanup`                      | no       | string | ``'true'``                                                                 |
@@ -1186,6 +1194,32 @@ check_pypi_duplicate
                   ``'false'`` - don't query PyPI, e.g. for a package that isn't published there.
 
 
+.. _JOBTMPL/CompletePipeline/Input/package_sdist:
+
+package_sdist
+=============
+
+:Type:            string
+:Required:        no
+:Default Value:   ``'true'``
+:Possible Values: ``'true'`` / ``'false'``
+:Description:     Build a source distribution (:file:`*.tar.gz`).
+                  Forwarded to :ref:`JOBTMPL/Package/Input/package_sdist`.
+
+
+.. _JOBTMPL/CompletePipeline/Input/package_wheel:
+
+package_wheel
+=============
+
+:Type:            string
+:Required:        no
+:Default Value:   ``'true'``
+:Possible Values: ``'true'`` / ``'false'``
+:Description:     Build a wheel (:file:`*.whl`).
+                  Forwarded to :ref:`JOBTMPL/Package/Input/package_wheel`.
+
+
 .. _JOBTMPL/CompletePipeline/Input/pypi_url:
 
 pypi_url
@@ -1219,6 +1253,36 @@ pypi_dry_run
                   ``'false'`` - publish the packages; a package with direct references isn't tagged.
 
 
+.. _JOBTMPL/CompletePipeline/Input/pypi_publish_sdist:
+
+pypi_publish_sdist
+==================
+
+.. attention::
+
+   The default value will be changed to ``'false'`` in Actions ``@r10``.
+
+:Type:            string
+:Required:        no
+:Default Value:   ``'true'``
+:Possible Values: ``'true'`` / ``'false'``
+:Description:     Publish the source distribution (:file:`*.tar.gz`) on a release tag.
+                  Forwarded to :ref:`JOBTMPL/PublishOnPyPI/Input/publish_sdist`.
+
+
+.. _JOBTMPL/CompletePipeline/Input/pypi_publish_wheel:
+
+pypi_publish_wheel
+==================
+
+:Type:            string
+:Required:        no
+:Default Value:   ``'true'``
+:Possible Values: ``'true'`` / ``'false'``
+:Description:     Publish the wheel (:file:`*.whl`) on a release tag.
+                  Forwarded to :ref:`JOBTMPL/PublishOnPyPI/Input/publish_wheel`.
+
+
 .. _JOBTMPL/CompletePipeline/Input/pypi_upload_url:
 
 pypi_upload_url

doc/JobTemplate/Package/Package.rst

@@ -12,7 +12,7 @@ as an artifact.
 
 .. topic:: Features
 
-   * Package source code as wheel and source distribution.
+   * Package source code as wheel and/or source distribution.
    * Support packaging using :term:`build` (recommended) or :pypi:`setuptools`.
    * Check the packages' metadata for direct references, which :term:`PyPI` rejects.
 
@@ -29,13 +29,14 @@ as an artifact.
       * If parameter :ref:`JOBTMPL/Package/Input/requirements` is non-empty, use :pypi:`setuptools` for packaging and
         execute ``python setup.py ...``.
 
-      Both a source distribution and a wheel are built.
+      A source distribution is built if :ref:`JOBTMPL/Package/Input/package_sdist` is ``'true'``, a wheel if
+      :ref:`JOBTMPL/Package/Input/package_wheel` is ``'true'``; both are by default.
 
-   4. Check both packages' metadata (``Requires-Dist``) for direct references like
+   4. Check the packages' metadata (``Requires-Dist``) for direct references like
       ``name @ git+https://...``, which :term:`PyPI` rejects. Each reference is reported as a warning naming the
       requirement, its extras and the packages it appears in. The result is the output
       :ref:`JOBTMPL/Package/Output/pypi_compliant`.
-   5. Upload both packages in a single artifact
+   5. Upload the packages in a single artifact
       (:ref:`JOBTMPL/Package/Input/artifact`).
 
 .. topic:: Job Execution
@@ -111,6 +112,10 @@ Parameter Summary
 +---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
 | :ref:`JOBTMPL/Package/Input/artifact`                               | yes      | string   | — — — —                                                           |
 +---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
+| :ref:`JOBTMPL/Package/Input/package_sdist`                          | no       | string   | ``'true'``                                                        |
++---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
+| :ref:`JOBTMPL/Package/Input/package_wheel`                          | no       | string   | ``'true'``                                                        |
++---------------------------------------------------------------------+----------+----------+-------------------------------------------------------------------+
 
 .. rubric:: Goto :ref:`secrets <JOBTMPL/Package/Secrets>`
 
@@ -169,6 +174,36 @@ artifact
 :Description:     Name of the artifact containing the packaged Python code.
 
 
+.. _JOBTMPL/Package/Input/package_sdist:
+
+package_sdist
+=============
+
+:Type:            string
+:Required:        no
+:Default Value:   ``'true'``
+:Possible Values: ``'true'`` / ``'false'``
+:Description:     Build a source distribution (:file:`*.tar.gz`). |br|
+                  ``'true'`` - the artifact contains the source distribution. |br|
+                  ``'false'`` - no source distribution is built; :ref:`JOBTMPL/PublishOnPyPI/Input/publish_sdist` must
+                  be ``'false'`` too.
+
+
+.. _JOBTMPL/Package/Input/package_wheel:
+
+package_wheel
+=============
+
+:Type:            string
+:Required:        no
+:Default Value:   ``'true'``
+:Possible Values: ``'true'`` / ``'false'``
+:Description:     Build a wheel (:file:`*.whl`). |br|
+                  ``'true'`` - the artifact contains the wheel. |br|
+                  ``'false'`` - no wheel is built; :ref:`JOBTMPL/PublishOnPyPI/Input/publish_wheel` must be
+                  ``'false'`` too, and jobs installing the wheel (e.g. :ref:`JOBTMPL/InstallPackage`) can't run.
+
+
 .. _JOBTMPL/Package/Secrets:
 
 Secrets