GrimoireLab GitHub actions

build

Build a Python package using Poetry and store the package as an artifact for future jobs.

See build/action.yml

Inputs

• artifact-name: artifact name for future jobs (default: artifact).
• artifact-path: directory that contains the package to store for future jobs (default: dist).
• skip-checkout: set to 'yes' to avoid checking out the repository (default: 'no').
• pin-dependencies: set to 'yes' to pin poetry.lock dependencies (default: 'no').

Usage

steps:
  - uses: chaoss/grimoirelab-github-actions/build@main
    with:
      artifact-name: grimoire-dist
      artifact-path: dist
      skip-checkout: yes
      pin-dependencies: yes

release

Create a new GitHub release for the repository.

It uses the tag that triggered the workflow and the notes available under releases/<tag>.md.

See release/action.yml

Inputs

• github-token: token provided by actions, read the usage.

Usage

steps:
  - uses: chaoss/grimoirelab-github-actions/release@main
    with:
      github-token: ${{ secrets.GITHUB_TOKEN }}

publish

Publish a Python package to PyPI using Poetry.

The package should be already built, you can use grimoirelab-github-actions/build.

See publish/action.yml

Inputs

• artifact-name: artifact name from previous jobs (default: artifact).
• artifact-path: directory that contains the package to publish (default: dist).
• pypi-api-token: token to publish the package in PyPI (required).

Usage

steps:
  - uses: chaoss/grimoirelab-github-actions/publish@main
    with:
      artifact-name: grimoire-dist
      artifact-path: dist
      pypi-api-token: ${{ secrets.PYPI_API_TOKEN }}