Setup Plone

   

This action set up Plone and Python within a Github workflow to be used in tests.

Inputs

python-version

Required Python version to be used.

Default value: 3.11.

plone-version

Required Plone version to be used.

Default value: 6.0.

setuptools-version

Setuptools version to be used. If not specified, we use the version from the constraints file of the chosen Plone version.

Default value: ``.

additional-packages

Additional packages to be installed. This is useful to pin versions of packages listed on contraints.txt. i.e.: plone.restapi>=8.13.0.

Default value: ``.

additional-eggs

Deprecated alias for additional-packages. Still supported for now.

Default value: ``.

Usage

Setup Plone

Add the a workflow file in your repository: .github/workflows/test.yml.

- name: Setup Plone 6.0.10.1 with Python 3.11
  uses: plone/setup-plone@v2.0.0
  with:
    python-version: '3.11'
    plone-version: '6.0.10.1'

- name: Install addon package, in editable mode, with pip
  run: |
    pip install -e ".[test]"

- name: Run tests (located inside src)
  run: |
    zope-testrunner --auto-color --auto-progress --test-path src/

Changes

v2.1.0 (unreleased)

• Use setuptools-version from chosen plone-version if not explicitly specified. [maurits]
• Mark plone-version and python-version as really required, setuptools-version and the others not. [maurits]
• Rename additional-eggs to additional-packages. Keep the previous spelling as well and use it, but mark it as deprecated. [maurits]
• Update actions/setup-python to v5. [maurits]

v2.0.0 (2022-12-05)

• Update actions/setup-python to v4. [ericof]

v1.2.0 (2022-11-23)

• Add support for setuptools-version option [ericof]

v1.1.0 (2021-11-10)

• Add support for additional-eggs option [ericof]

v1.0.0 (2021-10-29)

• Initial release of plone/setup-plone [ericof]

About

Plone CMS is the ultimate enterprise CMS.

Follow us