syncRepoHomepage

Compares a repository’s GitHub homepage with its site’s URL, and sets it or reports the mismatch.

It only warns: an unreadable repository, a mismatch it may not fix and a failed update each print the reason and the gh repo edit line, and inside GitHub Actions also a ::warning:: annotation.

Import:

import { syncRepoHomepage } from '@mnaoumov/typescript-dev-toolkit/docs-site/repo-homepage';

Signature:

function syncRepoHomepage(params: SyncRepoHomepageParams): Promise<void>

Parameters:

Parameter	Type	Description
params	SyncRepoHomepageParams	The repository, the site’s URL and the mode.

Returns: Promise<void>

---

Links to this page:

• SyncRepoHomepageParams