NAME

repomatic broken-links - Manage broken links issue lifecycle

SYNOPSIS

repomatic broken-links [OPTIONS]

DESCRIPTION

Manage the broken links issue lifecycle.

Combines Lychee and Sphinx linkcheck results into a single "Broken links" issue. Creates, updates, or closes the issue based on results.

Requires the gh CLI to be authenticated.

In GitHub Actions, most options are auto-detected:
- --repo-name defaults to $GITHUB_REPOSITORY name component.
- --body-file defaults to ./lychee/out.md when --lychee-exit-code is set.
- --output-json defaults to ./docs/_linkcheck/output.json if it exists.
- --source-url is composed from $GITHUB_SERVER_URL, $GITHUB_REPOSITORY,


  and $GITHUB_SHA when --output-json is set.

OPTIONS

--lychee-exit-code INTEGER

Exit code from lychee (0=no broken links, 2=broken links found).

--body-file FILE

Path to the issue body file (lychee output).

--output-json FILE

Path to Sphinx linkcheck output.json file.

--source-url TEXT

Base URL for linking filenames and line numbers in the Sphinx report. Example: https://github.com/owner/repo/blob/<sha>/docs

--repo-name TEXT

Repository name (for label selection). Defaults to $GITHUB_REPOSITORY name component.

--help / -h

Show this message and exit.

ENVIRONMENT

BROKEN_LINKS_LYCHEE_EXIT_CODE

Exit code from lychee (0=no broken links, 2=broken links found).

BROKEN_LINKS_BODY_FILE

Path to the issue body file (lychee output).

BROKEN_LINKS_OUTPUT_JSON

Path to Sphinx linkcheck output.json file.

BROKEN_LINKS_SOURCE_URL

Base URL for linking filenames and line numbers in the Sphinx report. Example: https://github.com/owner/repo/blob/<sha>/docs

BROKEN_LINKS_REPO_NAME

Repository name (for label selection). Defaults to $GITHUB_REPOSITORY name component.

BROKEN_LINKS__CLICK_DEFAULT_HELP

Show this message and exit.

EXIT STATUS

0

Success.

1

A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).

2

A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

EXAMPLES

In GitHub Actions, with every default auto-detected

repomatic broken\-links \-\-lychee\-exit\-code 2

Explicit options

repomatic broken\-links \-\-lychee\-exit\-code 2 \-\-body\-file ./lychee/out.md \-\-repo\-name "my\-repo"

AUTHORS

Kevin Deldycke