Reusable GitHub Actions Workflows

This repository contains reusable GitHub Actions workflows that can be used in any repository.

Workflows

Python tests

This workflow will:

1. Checkout the repository at the commit the workflow is running on.
2. Set up Python.
3. (Optional) Run any pre-install steps (see below).
4. Install the package with the specified extras.
5. Run the tests using the ./run-tests.sh script in the repository.

To use in your repository, add the following in your .github/workflows/tests.yml file under the jobs key:

# ...

jobs:

  Python:
    uses: inveniosoftware/workflows/.github/workflows/tests-python.yml@master
    # If you want to override some of the inputs:
    # with:
    #   extras: "tests,oaipmh"

Inputs

Important

Because reusable workflows don't support array inputs, the python-version, db-service, and search-service inputs are expected to be a JSON-encoded string.

Name	Description	Default	Example override
python-version	Python versions to test	'["3.9", "3.12"]'	'["3.10", "3.11"]'
extras	Package extras to install	tests	tests,oaipmh
db-service	Database services to include in the test matrix	'["postgresql14"]'	'["postgresql15", "mysql8"]'
search-service	Search services to include in the test matrix	'["opensearch2"]'	'["elasticsearch7", "opensearch2"]'

If you need to run the tests without any db or search service, just define it as the following:

jobs:

  Python:
    uses: inveniosoftware/workflows/.github/workflows/tests-python.yml@master
    with:
      db-service: '[""]'
      search-service: '[""]'

Pre-install

In case you want to run additional steps before Python dependencies are install, you can create a .github/actions/pre-install/actions.yml file in your repository. This file should contain a list of steps to run before the dependencies are installed.

For example if you need to install graphviz, you can create the following file:

# .github/actions/pre-install/actions.yml
runs:
  using: composite
  steps:
    - uses: ts-graphviz/setup-graphviz@v1

JS tests

This workflow will:

1. Checkout the repository at the commit the workflow is running on.
2. Set up Node.js.
3. Run the linter using the ./run-js-linter.sh script in the repository.
4. Install test dependencies if the js-working-directory input is set.
5. Install frontend dependencies if the translations-working-directory input is set.
6. Run the tests using the ./run-js-tests.sh script in the repository.

To use in your repository, add the following in your .github/workflows/tests.yml file under the jobs key:

# ...

jobs:

  JS:
    uses: inveniosoftware/workflows/.github/workflows/tests-js.yml@master
    with:
      js-working-directory: "./invenio_foobar/assets/semantic-ui/js/invenio_foobar"
      # If you you don't have translations to test, just skip this line
      translations-working-directory: "./invenio_foobar/assets/semantic-ui/translations/invenio_foobar"

Inputs

Name	Description	Default	Example
node-version	Node versions to test	["18.x", "20.x"]	["20.x", "22.x"]
js-working-directory	Working directory for JS tests. If unset, not tests will run	Unset	./invenio_foobar/assets/semantic-ui/js/invenio_foobar
translations-working-directory	Working directory for translations tests. If unset no tests will run	Unset	./invenio_foobar/assets/semantic-ui/translations/invenio_foobar

Publish package on PyPI

This workflow will:

1. Checkout the repository at the commit the workflow is running on.
2. Set up Python.
3. Installs required dependencies (build, twine)
4. Build the distribution package (source distribution and wheel)
5. Publish the package in PyPI using twine

When the optional input babel-compile-catalog is set to true, it will also install Babel and run python setup.py compile_catalog to compile the message catalog from a PO file and to a binary MO file (see doc here).

To use in your repository, add the following in your .github/workflows/pypi-publish.yml file under the jobs key:

# ...

jobs:

  Build-N-Publish:
    uses: inveniosoftware/workflows/.github/workflows/pypi-publish.yml@master
    secrets: inherit
    # If you want to enable the compilation of the translations catalog, configure it with:
    # with:
    #   babel-compile-catalog: true

The secrets: inherit part is necessary, so that the PYPI_TOKEN secret (and other secrets) can be used by the reusable workflow when publishing. See doc here.

Inputs

Name	Description	Default	Example override
babel-compile-catalog	Compile the message catalog from a PO file to a binary MO file (see doc here)	false	true