PublishToGitHubPages

This job template publishes HTML content from artifacts of other jobs to GitHub Pages.

Instantiation

Simple Example

jobs:
  BuildTheDocs:
    # ...

  PublishToGitHubPages:
    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
    needs:
      - BuildTheDocs
    with:
      doc: Documentation

Complex Example

jobs:
  PublishToGitHubPages:
    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r5
    needs:
      - Params
      - BuildTheDocs
      - Coverage
      - StaticTypeCheck
    with:
      doc:      ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
      coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
      typing:   ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}

Parameter Summary

Goto input parameters

Parameter Name	Required	Type	Default
ubuntu_image_version	no	string	`'24.04'`
doc	yes	string	— — — —
coverage	no	string	`''`
typing	no	string	`''`

Goto secrets

This job template needs no secrets.

Goto output parameters

This job template has no output parameters.

Input Parameters

ubuntu_image_version

Type:: string
Required:: no
Default Value:: '24.04'
Possible Values:: See actions/runner-images - Available Images for available Ubuntu image versions.
Description:: Version of the Ubuntu image used to run the job.

Note

Unfortunately, GitHub Actions has only a limited set of functions, thus, the usual Ubuntu image name like 'ubuntu-24.04' can’t be split into image name and image version.

doc

Type:: string
Required:: yes
Default Value:: — — — —
Possible Values:: Any valid artifact name.
Description:: Name of the documentation artifact containing the HTML website.

coverage

Type:: string
Required:: no
Default Value:: ''
Possible Values:: Any valid artifact name.
Description:: Name of the coverage artifact containing the HTML coverage report, which will be integrated as a subdirectory.

typing

Type:: string
Required:: no
Default Value:: ''
Possible Values:: Any valid artifact name.
Description:: Name of the type checking artifact containing the HTML type checker report, which will be integrated as a subdirectory.

Secrets

This job template needs no secrets.

Outputs

This job template has no output parameters.

Optimizations

This template offers no optimizations (reduced job runtime).