@pvm/types
Enumerations
Classes
Interfaces
- AbstractVcs
- AddTagOptions
- AlterReleaseResult
- ArtifactLimitDef
- BranchStorageDef
- Changelog
- ChangelogRendererBuiltin
- ChangelogRendererByPlugin
- ChangelogRendererCommonJs
- Commit
- CommitOptions
- CommitResult
- Committer
- Config
- CreateReleasePayload
- DiffStats
- Env
- ExecShellOptions
- ExternalStorageDef
- FileCommitApi
- MessengerClientLoadConfig
- MetaComment
- MetaRepository
- NamedDiff
- PkgAppliedMeta
- PkgFailStats
- PkgMeta
- PkgSkippedStats
- PkgSuccessStats
- PlatformRelease
- PlatformReleaseTag
- PublishConfig
- PublishedStats
- PushOptions
- RefRecord
- ReleasePayload
- ReleasedProps
- RepoStorageDef
- RunShellOptions
- UnknownCommitContext
- UpdateHints
- VcsOnly
- VcsRelease
Type aliases
ChangelogRenderer
ฦฌ ChangelogRenderer: ChangelogRendererBuiltin | ChangelogRendererCommonJs | ChangelogRendererByPlugin
Defined in
packages/pvm-types/lib/config-schema.ts:43
GetReleaseResult
ฦฌ GetReleaseResult: [OK, PlatformRelease] | [NOT_FOUND | NO_SUCH_TAG, null]
Defined in
packages/pvm-types/lib/vcs.ts:86
Message
ฦฌ Message: Object
Type declaration
| Name | Type | Description |
|---|---|---|
attachments? | { fallback?: string ; pretext?: string ; text?: string ; title?: string }[] | Less important content that should be attached to post. Example from mattermost. https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/ Options set is limited in order to support other possible messengers which may be less capable |
author? | Object | Displayed post author customization (not supported in all messengers) |
author.avatarEmoji? | string | - |
author.avatarUrl? | string | - |
author.name? | string | - |
channel? | string | Channel id or name (in case of slack) where to send message |
content | string | Main message |
Defined in
packages/pvm-types/lib/messages.ts:1
MessengerClientConfig
ฦฌ MessengerClientConfig: Pick<Message, "channel" | "author"> & { [key: string]: any; }
Defined in
packages/pvm-types/lib/messages.ts:33
MessengerName
ฦฌ MessengerName: string
Defined in
packages/pvm-types/lib/config-schema.ts:50
PkgDeps
ฦฌ PkgDeps: Record<string, string>
Defined in
packages/pvm-types/lib/pkg-meta.ts:1
PluginConfig
ฦฌ PluginConfig: Object
Type declaration
| Name | Type |
|---|---|
options? | PluginOptions |
plugin | string | PluginFactory | PluginDeclaration |
Defined in
packages/pvm-types/lib/di.ts:18
PluginDeclaration
ฦฌ PluginDeclaration: { name: string } & { factory: PluginFactory } | { configExt: RecursivePartial<Config> } | { configExt: RecursivePartial<Config> ; factory: PluginFactory }
Defined in
packages/pvm-types/lib/di.ts:9
PluginFactory
ฦฌ PluginFactory: (opts: PluginOptions) => { providers: Provider[] }
Type declaration
โธ (opts): Object
Parameters
| Name | Type |
|---|---|
opts | PluginOptions |
Returns
Object
| Name | Type |
|---|---|
providers | Provider[] |
Defined in
packages/pvm-types/lib/di.ts:7
PluginOptions
ฦฌ PluginOptions: Record<string, any>
Defined in
packages/pvm-types/lib/di.ts:5
PvmReleaseType
ฦฌ PvmReleaseType: "none" | SemverReleaseType
Defined in
packages/pvm-types/lib/publish.ts:41
RecursivePartial
ฦฌ RecursivePartial<T>: { [P in keyof T]?: T[P] extends Record<string, unknown> ? RecursivePartial<T[P]> : T[P] }
Type parameters
| Name |
|---|
T |
Defined in
packages/pvm-types/lib/helpers.ts:1
SemverReleaseType
ฦฌ SemverReleaseType: "prerelease" | "prepatch" | "patch" | "preminor" | "minor" | "premajor" | "major"
Defined in
packages/pvm-types/lib/publish.ts:40
StorageDef
ฦฌ StorageDef: RepoStorageDef | BranchStorageDef | ExternalStorageDef