Workflows

A collection of github workflows for reuse. Some of the workflow files assume that files will exist in the original directory and will fail if they do not exist.

lint_python.yml

Inputs

• python-version: default 3.9; the version of python to use

Secrets

None

Outputs

None

Assumptions

• requirements.txt file at root level; specify packages needed by code to be linted
• requirements-lint.txt file at root level; specify versions of pylint and pyright for linting. Example:

pylint==2.15.4
pyright==1.1.276

Example

jobs:
  lint:
    uses: seamuslowry/workflows/.github/workflows/lint_python.yml@main

publish_python.yml

Inputs

• release-version: required; the version to release
• repo: default pypi; what repo to publish the release to
• python-version: default 3.9; the version of python to use

Secrets

• py_pi_token: required; the API token to use to publish

Outputs

None

Assumptions

• requirements.txt file at root level; specify packages needed by code to be linted
• requirements-publish.txt file at root level; specify versions of build and twine for publishing

build==0.8.0
twine==4.0.1

Example

jobs:
  publish:
    uses: seamuslowry/workflows/.github/workflows/publish_python.yml@main
    with:
      repo: testpypi
      release-version: 0.0.1
      compose-file: docker-compose.yml
    secrets:
      py_pi_token: ${{ secrets.TEST_PYPI_API_TOKEN }}

test_python.yml

Inputs

• min-coverage: default 100; minimum percentage of code must be coverage
• python-version: default 3.9; the version of python to use
• compose-file: not required; expects a docker compose file; if passed, will build and up the file before tests and bring it down after

Secrets

None

Outputs

None

Assumptions

• requirements.txt file at root level; specify packages needed by code to be linted
• requirements-test.txt file at root level; specify versions of pytest and coverage for testing and coverage

pytest==7.1.3
coverage==6.5.0

Example

jobs:
  test:
    uses: seamuslowry/workflows/.github/workflows/test_python.yml@main

tag.yml

Inputs

• with-v: default false; whether to include v in tag version
• dry-run: default false; generate the next tag value but do not create the tag
• custom-tag: custom tag value to use; other tag related settings get ignored

Secrets

• gh_token: the GITHUB_TOKEN secret so it can create a tag

Outputs

• tag: the semantic version string of the created tag

Assumptions

None

Example

jobs:
  tag-new-version:
    uses: seamuslowry/workflows/.github/workflows/tag.yml@main
    secrets:
      gh_token: ${{ secrets.GITHUB_TOKEN }}

deploy_python_functions.yml

Inputs

• name: the name of the functions app to deploy to
• path: default "."; the path to the project to deploy
• python-version: default 3.9; the version of python to use

Secrets

• azure_publish_profile: the publish profile from azure to use; will include the deployment slot, if applicable

Outputs

None

Assumptions

• requirements.txt file at root level; specify packages needed by code to be published

Example

jobs:
  deploy:
    uses: seamuslowry/workflows/.github/workflows/deploy_python_functions.yml@main
    with:
      name: appname
    secrets:
      azure_publish_profile: ${{ secrets.AZURE_PROD_PUBLISH }}

lint_actions.yml

Inputs

• reporter: passthrough to reporter of reviewdog. Use github-pr-review when run on PR actions and want to leave a review. Use github-check when running on push/merge and don't want a PR review.

Secrets

• gh_token: the GITHUB_TOKEN secret so it can report

Outputs

None

Assumptions

None

Example

jobs:
  lint:
    uses: seamuslowry/workflows/.github/workflows/lint_actions.yml@main
    with:
      reporter: github-check
    secrets:
      gh_token: ${{ secrets.GITHUB_TOKEN }}