Directories
¶
| Path | Synopsis |
|---|---|
|
Package backend defines the interface every git hosting adapter (GitHub, GitLab, Gitea, Forgejo) implements identically.
|
Package backend defines the interface every git hosting adapter (GitHub, GitLab, Gitea, Forgejo) implements identically. |
|
forgejo
Package forgejo implements backend.Backend against the Forgejo REST API (api/v1).
|
Package forgejo implements backend.Backend against the Forgejo REST API (api/v1). |
|
gitea
Package gitea implements backend.Backend against the Gitea REST API (api/v1), which is close enough to GitHub's release API in shape (tag_name/name/body/draft) that the adapter logic mirrors internal/backend/github — the differences are the base path, the Authorization header scheme, and list pagination's query param names.
|
Package gitea implements backend.Backend against the Gitea REST API (api/v1), which is close enough to GitHub's release API in shape (tag_name/name/body/draft) that the adapter logic mirrors internal/backend/github — the differences are the base path, the Authorization header scheme, and list pagination's query param names. |
|
github
Package github implements backend.Backend against the GitHub REST API.
|
Package github implements backend.Backend against the GitHub REST API. |
|
gitlab
Package gitlab implements backend.Backend against the GitLab Releases API.
|
Package gitlab implements backend.Backend against the GitLab Releases API. |
|
commands
|
|
|
draft
Package draft implements the "draft" command: compute entries since the last release and upsert the draft release(s) on the backend.
|
Package draft implements the "draft" command: compute entries since the last release and upsert the draft release(s) on the backend. |
|
preview
Package preview implements the "preview" command: compute entries since the last release and print the resulting notes to stdout, without touching the backend.
|
Package preview implements the "preview" command: compute entries since the last release and print the resulting notes to stdout, without touching the backend. |
|
publish
Package publish implements the "publish" command: promote a draft release to published, tagging it on the backend.
|
Package publish implements the "publish" command: promote a draft release to published, tagging it on the backend. |
|
shared
Package shared provides flags common to multiple draftsman commands.
|
Package shared provides flags common to multiple draftsman commands. |
|
Package commit parses Conventional Commit messages.
|
Package commit parses Conventional Commit messages. |
|
Package config loads and defaults a repo's .draftsman.yml.
|
Package config loads and defaults a repo's .draftsman.yml. |
|
Package engine computes a release Plan from a repository's commit history.
|
Package engine computes a release Plan from a repository's commit history. |
|
Package git reads commit history from a local repository.
|
Package git reads commit history from a local repository. |
|
Package version parses and increments SemVer versions, and matches them against a configurable tag-format template.
|
Package version parses and increments SemVer versions, and matches them against a configurable tag-format template. |
Click to show internal directories.
Click to hide internal directories.