Skip to content

Feature: Use git tag instead of main branch for production docs. #432

@schultek

Description

@schultek

I semi-regularly have the case that I have unreleased changes on my main branch before releasing a new version of my package. During these periods (normally couple days to a few weeks) the production documentation is not reflecting the released package, because it already contains the updated docs for the new changes (which aren't release yet as said).

I don't want to change my workflow just for the documentation. It would be great to have some configuration to say what to show as the live production documentation as an alternative to only using the default branch. E.g. point it to a specific git tag, and then the main docs (at docs.page/myuser/myrepo or custom domain) would not load the source from the latest commit of the main branch, but instead from the commit of the configured tag.
I could then always point it to the git tag of the latest release, and only update it after releasing a new version.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions