GHA Workflows

This repository hosts a set of custom reusable github actions workflows.

Available workflows

• package-test-uv.yml
• promote-staging-to-production.yml
• package-test-legacy.yml
• package-test-coverage.yml

package-test-uv.yml

Test a Plone package. Test environment is bootstrapped using uv and buildout.

Note: Supported Python versions are listed on uv documentation. If you need to use a deprecated Python 3 version, you can pin an older uv version using the uv_version input. For Python 2 support, use the package-test-legacy.yml workflow instead.

Inputs

Name	Type	Required	Default	Description
buildout_command	string	No	.venv/bin/buildout	Command to run buildout
buildout_config_file	string	No	buildout.cfg	Buildout configuration file to use
buildout_options	string	No	(empty)	Additional options to pass to buildout
continue_on_error	boolean	No	true	Continue on error
python_version	string	No	3.13	Python version to use
requirements_file	string	No	requirements.txt	Requirements file to use for dependency installation
runner_label	string	No	ubuntu-latest	GitHub Actions runner label to use
soffice	boolean	No	false	Launch soffice (LibreOffice in service mode)
system_dependencies	string	No	(empty)	System dependencies to install before running tests
test_command	string	No	bin/test	Command to run tests
uv_version	string	No	0.7.20	Version of uv to use

Secrets:

Name	Required	Description
mattermost_webhook_url	No	Mattermost webhook URL for notifications (optional)

Example of usage

Simple use-case (one version)

Tip: If your repository follows the default values for all workflow inputs, you only need this single line to run the tests.

test:
    uses: IMIO/gha-workflows/.github/workflows/package-test-uv.yml@v1

Multiple versions (github actions matrixes)

Thanks to github actions matrixes, you can launch tests on multiple plone and python versions.

In the below example, we run tests on 2 python versions and 2 plone versions (4 tests in total). You need a specific requirements and buildout config file for each plone version.

test:
    uses: IMIO/gha-workflows/.github/workflows/package-test-uv.yml@v1
    strategy:
      matrix:
        python_version: ['3.10', '3.13']
        plone_version: ['6.0', '6.1']
    with:
      buildout_config_file: gha_${{ matrix.plone_version }}.cfg
      python_version: ${{ matrix.python_version }}
      requirements_file: requirements_${{ matrix.plone_version }}.txt

promote-staging-to-production.yml

This workflow promotes a Docker image from staging to production and deploys it using Rundeck.

It tags the specified Docker image in the registry and notifies via Mattermost.

It also runs a Rundeck job to deploy the image to the specified node.

Inputs

Name	Type	Required	Default	Description
github_environment	string	No	production	GitHub environment to use for the job
image_name	string	Yes	—	Name of the Docker image
image_tag_staging	string	Yes	—	Tag of the Docker image in staging
image_tag_production	string	Yes	—	Tag of the Docker image in production
rundeck_job_id	string	Yes	—	ID of the Rundeck job to run for deployment
quick_release	boolean	No	false	Whether this is a quick release
runner_label	string	No	gha-runners	Label for the GitHub runner to use
schedule_time	string	No	03:00	Time to schedule the deployment tomorrow (e.g., "03:00")
service_name	string	No	—	Name of the service being deployed

Note

If your RunDeck job needs to specify nodes (it's the case for a job where nodes are not checked by default), you can specify nodes by setting a GitHub environment variable called NODE_NAME. Multiple nodes can be specified, separated by commas (e.g., node1.lan,node2.lan).

Secrets:

Name	Required	Description
mattermost_webhook_url	No	Webhook URL for Mattermost notifications
registry_url	Yes	URL of the registry
registry_username	Yes	Username for the registry
registry_password	Yes	Password for the registry
rundeck_url	Yes	URL of the Rundeck server
rundeck_token	Yes	Token for the Rundeck server

Example of usage

jobs:
  promote-staging-to-production:
    uses: IMIO/gha-workflows/.github/workflows/promote-staging-to-production.yml@v1
    with:
      github_environment: production
      image_name: myapp
      image_tag_staging: staging
      image_tag_production: latest
      rundeck_job_id: 5b7c2640-1234-4b52-abcd-32745b326cd1
      runner_label: ubuntu-latest
      schedule_time: '02:00'
      service_name: myappservice
      quick_release: true
    secrets:
      registry_url: ${{ secrets.HARBOR_URL }}
      registry_username: ${{ secrets.HARBOR_USERNAME }}
      registry_password: ${{ secrets.HARBOR_PASSWORD }}
      rundeck_url: ${{ secrets.RUNDECK_URL }}
      rundeck_token: ${{ secrets.RUNDECK_TOKEN }}

package-test-legacy.yml

Test a Plone package using legacy buildout and Python versions.

Inputs

Name	Type	Required	Default	Description
buildout_command	string	No	bin/buildout	Command to run buildout
buildout_config_file	string	No	buildout.cfg	Buildout configuration file to use
continue_on_error	boolean	No	false	Continue on error
matrix_experimental	boolean	No	false	Enable experimental matrix
plone_version	string	No	4.3	Plone version to use
python_version	string	No	2.7	Python version to use
requirements_file	string	No	requirements.txt	Requirements file to use for dependency installation
runner_label	string	No	ubuntu-latest	GitHub Actions runner label to use
soffice	boolean	No	false	Launch soffice (LibreOffice in service mode)
test_command	string	No	bin/test	Command to run tests

Secrets:

Name	Required	Description
mattermost_webhook_url	No	Mattermost webhook URL for notifications (optional)

Example of usage

test:
    uses: IMIO/gha-workflows/.github/workflows/package-test-legacy.yml@v1
    with:
      buildout_config_file: buildout.cfg
      python_version: 2.7
      requirements_file: requirements.txt

package-test-coverage.yml

Test a Plone package and generate a coverage report. Test environment is bootstrapped using uv and buildout. Optionally uploads the coverage report to Coveralls.

Inputs

Name	Type	Required	Default	Description
buildout_command	string	No	.venv/bin/buildout	Command to run buildout
buildout_config_file	string	No	buildout.cfg	Buildout configuration file to use
buildout_options	string	No	(empty)	Additional options to pass to buildout
continue_on_error	boolean	No	false	Continue on error
plone_version	string	No	6.1	Plone version to use
requirements_file	string	No	requirements.txt	Requirements file to use for dependency installation
runner_label	string	No	ubuntu-latest	GitHub Actions runner label to use
soffice	boolean	No	false	Launch soffice (LibreOffice in service mode)
test_command	string	No	uvx coverage run bin/test -t !robot >> $GITHUB_STEP_SUMMARY	Command to run tests with coverage
upload_to_coveralls	boolean	No	false	Upload coverage report to Coveralls

Secrets:

Name	Required	Description
mattermost_webhook_url	No	Mattermost webhook URL for notifications (optional)

Example of usage

test:
    uses: IMIO/gha-workflows/.github/workflows/package-test-coverage.yml@v1
    with:
      upload_to_coveralls: true