.. include:: ../../README.rst
   :start-after: .. readme_common_begins
   :end-before: .. readme_common_ends

.. note:: Adapting to a new version?

   If you are adapting to a new version of the actions, see the
   :ref:`migration_guide`.

For more information on available actions and how to use them,
see each of these cards:

.. grid:: 1 1 2 2
    :gutter: 2

    .. grid-item-card:: :octicon:`codescan-checkmark` Style actions
       :link: style-actions/index
       :link-type: doc

       Style actions verify code and documentation.

    .. grid-item-card:: :octicon:`tools` Tests actions
       :link: tests-actions/index
       :link-type: doc

       Tests actions allow to run the test suite.

    .. grid-item-card:: :octicon:`book` Docs actions
       :link: doc-actions/index
       :link-type: doc

       Documentation actions build and deploy the documentation.

    .. grid-item-card:: :octicon:`key` Licence actions
       :link: licenses-actions/index
       :link-type: doc

       License actions allows to verify that the project's dependencies only contain valid licenses.


    .. grid-item-card:: :octicon:`package` Build actions
       :link: build-actions/index
       :link-type: doc

       Build actions allow for building artifacts.

    .. grid-item-card:: :octicon:`eye` Release actions
       :link: release-actions/index
       :link-type: doc

       Release actions provide for releasing the various artifacts.

    .. grid-item-card:: :octicon:`archive` Housekeeping actions
       :link: housekeeping-actions/index
       :link-type: doc

       Housekeeping actions provide for general repository operations such as package cleanup.

    .. grid-item-card:: :octicon:`shield` Vulnerabilities actions
       :link: vulnerability-actions/index
       :link-type: doc

       Vulnerabilities actions provide for actively checking library and third party vulnerabilities.

.. toctree::
   :hidden:
   :maxdepth: 3

   style-actions/index
   tests-actions/index
   doc-actions/index
   licenses-actions/index
   build-actions/index
   release-actions/index
   housekeeping-actions/index
   vulnerability-actions/index
   migrations/index