mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
105 lines
2.0 KiB
ReStructuredText
105 lines
2.0 KiB
ReStructuredText
.. _JOBTMPL/InstallPackage:
|
|
.. index::
|
|
single: pip; InstallPackage Template
|
|
single: GitHub Action Reusable Workflow; InstallPackage Template
|
|
|
|
InstallPackage (beta)
|
|
#####################
|
|
|
|
The ``InstallPackage`` job template takes a generated Python package and installs it on the target platform. Afterwards
|
|
the installation is verified. This aims for packaging and dependency mistakes in the package.
|
|
|
|
.. topic:: Features
|
|
|
|
* Install generated Python package on the target platform.
|
|
|
|
.. topic:: Behavior
|
|
|
|
* Download Python package as artifact.
|
|
* Prepare the Python environment.
|
|
* Install the Python package using ``pip``.
|
|
* Read out and verify the package version.
|
|
|
|
.. topic:: Job Execution
|
|
|
|
.. image:: ../../_static/pyTooling-Actions-InstallPackage.png
|
|
:width: 500px
|
|
|
|
.. topic:: Dependencies
|
|
|
|
* :gh:`actions/checkout`
|
|
* :gh:`pyTooling/download-artifact`
|
|
|
|
* :gh:`actions/download-artifact`
|
|
|
|
* :gh:`msys2/setup-msys2`
|
|
* :gh:`actions/setup-python`
|
|
* pip
|
|
|
|
* :pypi:`pip`
|
|
* :pypi:`wheel`
|
|
|
|
|
|
.. _JOBTMPL/InstallPackage/Instantiation:
|
|
|
|
Instantiation
|
|
*************
|
|
|
|
.. todo::
|
|
|
|
InstallPackage:: Needs instantiation instructions.
|
|
|
|
|
|
.. _JOBTMPL/InstallPackage/Parameters:
|
|
|
|
Parameter Summary
|
|
*****************
|
|
|
|
.. rubric:: Goto :ref:`input parameters <JOBTMPL/InstallPackage/Inputs>`
|
|
|
|
.. todo::
|
|
|
|
InstallPackage:: Needs a parameter list.
|
|
|
|
.. rubric:: Goto :ref:`secrets <JOBTMPL/InstallPackage/Secrets>`
|
|
|
|
This job template needs no secrets.
|
|
|
|
.. rubric:: Goto :ref:`output parameters <JOBTMPL/InstallPackage/Outputs>`
|
|
|
|
This job template has no output parameters.
|
|
|
|
|
|
.. _JOBTMPL/InstallPackage/Inputs:
|
|
|
|
Input Parameters
|
|
****************
|
|
|
|
.. todo::
|
|
|
|
InstallPackage:: Needs input parameter descriptions.
|
|
|
|
|
|
.. _JOBTMPL/InstallPackage/Secrets:
|
|
|
|
Secrets
|
|
*******
|
|
|
|
This job template needs no secrets.
|
|
|
|
|
|
.. _JOBTMPL/InstallPackage/Outputs:
|
|
|
|
Outputs
|
|
*******
|
|
|
|
This job template has no output parameters.
|
|
|
|
|
|
.. _JOBTMPL/InstallPackage/Optimizations:
|
|
|
|
Optimizations
|
|
*************
|
|
|
|
This template offers no optimizations (reduced job runtime).
|