Skip to content

Github Actions to automate documentation site build on new release #153

@dskarbrevik

Description

@dskarbrevik

Is your feature request related to a problem? Please describe.

The langfair docs site tries to provide version specific documentation via a dropdown menu in the top right of the site. With each Major or minor release we want to stay on top of building a new docs site and updating the version switcher.

Describe the solution you'd like

This can be achieved automatically with a github actions workflow that triggers on new release. The workflow needs to pull the latest release into the gh-pages branch and build the docs site, moving "latest" down to it's own release and replacing it with this new build. The json file that controls the switcher functionality also needs to be updated.

Describe alternatives you've considered

Current approach is to manually do this but it can be time consuming, tedious and most of all easy to overlook during a release.

Additional context

Reach out to @dskarbrevik for more guidance or questions if interested in taking up this work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions