Workflows

Your Salt extension repository includes several workflows out of the box if your source_url is on GitHub.

Note

The workflows used within the salt-extensions organization (org) are equivalent to the enhanced ones.

Provided functions

The workflows currently:

  • Ensure pre-commit checks pass

  • Run the test suite

  • Build the documentation

  • Optionally deploy built documentation to GitHub Pages

  • Optionally build and release your project to PyPI

Repository setup

Required settings (all)

If publishing documentation to GitHub Pages, ensure you have set up your repository to allow deployments from GitHub Actions.

Required secrets (non-org)

If your repository is not hosted within the salt-extensions organization, you need to add the following secrets:

PYPI_API_TOKEN

An API token for PyPI for releasing your Saltext.

TEST_PYPI_API_TOKEN

An API token for TestPyPI for testing the release of your Saltext.

Important

Workflows are expected to migrate to Trusted Publishing soon, making these secrets obsolete.

Important artifacts

After a workflow run, several artifacts are available for download on the action summary page (scroll down).

runtests-*.log

Contains logs generated during a specific test run, useful for debugging test failures.

html-docs

The built HTML documentation, also available for preview when triggered by a Pull Request.

Workflows call stack

  1. .github/workflows/pr.yml or .github/workflows/tag.yml is triggered

  2. .github/workflows/ci.yml (or its equivalent centralized workflow) is called as the main entry point to CI

  3. Depending on the event and inputs, select additional workflows perform the necessary tasks.