changelog.ts

Declarations
#

view source

update_changelog
#

changelog.ts view source

(owner: string, repo: string, path?: string, token?: string | undefined, log?: Logger | undefined, cache?: Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }>): Promise<...>

Updates a changelog produced by @changesets/changelog-git with better links and formatting. It's similar to @changesets/changelog-github but doesn't require a token for light usage. This may be better implemented as a standalone dependency as an alternative to @changesets/changelog-git.

owner

type string

repo

type string

path

type string
default 'CHANGELOG.md'

token?

type string | undefined
optional

log?

type Logger | undefined
optional

cache

type Map<string, { key: string; url: string; params: any; value: any; etag: string | null; last_modified: string | null; }>
default new Map()

returns

Promise<boolean>

boolean indicating if the changelog changed

Depends on
#

Imported by
#