great-docs changelog
Generate a Changelog page from repository releases
great-docs changelog [OPTIONS]Fetch published releases from the repository API and render them as a changelog.qmd page in the build directory. The page is also linked in the navbar automatically.
Require a GitHub or GitLab repository URL in the project configuration or metadata. Set GITHUB_TOKEN or GH_TOKEN for GitHub, or GITLAB_TOKEN for GitLab.
Full --help output
Usage: great-docs changelog [OPTIONS]
Generate a Changelog page from repository releases
Fetch published releases from the repository API and render them as a
'changelog.qmd' page in the build directory. The page is also linked in the
navbar automatically.
Require a GitHub or GitLab repository URL in the project configuration or metadata.
Set 'GITHUB_TOKEN' or 'GH_TOKEN' for GitHub, or 'GITLAB_TOKEN' for GitLab.
Options:
--project-path DIRECTORY Path to your project root directory (default:
current directory)
--max-releases INTEGER Maximum number of releases to include (default:
from config or 50)
--config FILE Path to the project configuration file
--help Show this message and exit.
Options
--project-path: DIRECTORY- Path to your project root directory (default: current directory)
--max-releases: INTEGER- Maximum number of releases to include (default: from config or 50)
--config: FILE- Path to the project configuration file