Interface: Env
@pvm/types.Env
Env variables, used by pvm
Defaults
Properties
CI
• Optional CI: "true" | "false"
Flag that script running in continuous integration environment
Defined in
packages/pvm-types/lib/env-schema.ts:60
CI_COMMIT_REF_NAME
• Optional CI_COMMIT_REF_NAME: string
Git ref of commit on which pipeline running
Defined in
packages/pvm-types/lib/env-schema.ts:66
CI_COMMIT_SHA
• Optional CI_COMMIT_SHA: string
The SHA of commit where pipeline running
Defined in
packages/pvm-types/lib/env-schema.ts:94
CI_COMMIT_TAG
• Optional CI_COMMIT_TAG: string
The commit tag name. Available only in pipelines for tags
Defined in
packages/pvm-types/lib/env-schema.ts:90
CI_PIPELINE_URL
• Optional CI_PIPELINE_URL: string
Url of pipeline where pvm running
Defined in
packages/pvm-types/lib/env-schema.ts:86
CI_PROJECT_ID
• Optional CI_PROJECT_ID: string
Project ID in vcs platform. Used in calls to vcs platform api.
Defined in
packages/pvm-types/lib/env-schema.ts:74
CI_PROJECT_NAME
• Optional CI_PROJECT_NAME: string
The project name
Defined in
packages/pvm-types/lib/env-schema.ts:102
CI_PROJECT_NAMESPACE
• Optional CI_PROJECT_NAMESPACE: string
The project namespace (username or group name)
Defined in
packages/pvm-types/lib/env-schema.ts:98
CI_PROJECT_PATH
• Optional CI_PROJECT_PATH: string
The project namespace with the project name included
Defined in
packages/pvm-types/lib/env-schema.ts:82
CI_PROJECT_URL
• Optional CI_PROJECT_URL: string
Vcs platform project url (example: https://example.com/some-org/some-project)
Defined in
packages/pvm-types/lib/env-schema.ts:70
CI_SERVER_HOST
• Optional CI_SERVER_HOST: string
Host of CI server
Defined in
packages/pvm-types/lib/env-schema.ts:78
DEBUG
• Optional DEBUG: string
If set with 'pvm' string, then treated as PVM_LL=debug
Defined in
packages/pvm-types/lib/env-schema.ts:152
GITHUB_AUTH
• Optional GITHUB_AUTH: string
Auth strategy options.
Defined in
packages/pvm-types/lib/env-schema.ts:178
GITHUB_HEAD_REF
• Optional GITHUB_HEAD_REF: string
The head ref or source branch of the pull request in a workflow run. This property is only set when the event that triggers a workflow run is either pull_request or pull_request_target. For example, feature-branch-1.
Defined in
packages/pvm-types/lib/env-schema.ts:206
GITHUB_REF_NAME
• Optional GITHUB_REF_NAME: string
The branch or tag name that triggered the workflow run.
Defined in
packages/pvm-types/lib/env-schema.ts:202
GITHUB_REF_TYPE
• Optional GITHUB_REF_TYPE: "branch" | "tag"
The type of ref that triggered the workflow run. Valid values are branch or tag
Defined in
packages/pvm-types/lib/env-schema.ts:198
GITHUB_RUN_ID
• Optional GITHUB_RUN_ID: string
A unique number for each run within a repository. This number does not change if you re-run the workflow run
Defined in
packages/pvm-types/lib/env-schema.ts:186
GITHUB_SERVER_URL
• Optional GITHUB_SERVER_URL: string
Returns the URL of the GitHub server. For example: https://github.com.
Defined in
packages/pvm-types/lib/env-schema.ts:194
GITHUB_SHA
• Optional GITHUB_SHA: string
The commit SHA that triggered the workflow
Defined in
packages/pvm-types/lib/env-schema.ts:190
GITHUB_TOKEN
• Optional GITHUB_TOKEN: string
Token, provided by github and used for token authentication https://github.com/octokit/authentication-strategies.js/#github-action-authentication
It can also be personal or app access token, manually provided via secrets
Defined in
packages/pvm-types/lib/env-schema.ts:174
GITLAB_AUTH_COMMAND
• Optional GITLAB_AUTH_COMMAND: string
Shell command that outputs generated GITLAB_TOKEN. Used when token generating dynamically.
Defined in
packages/pvm-types/lib/env-schema.ts:220
GITLAB_CI
• Optional GITLAB_CI: "true" | "false"
see CI
Defined in
packages/pvm-types/lib/env-schema.ts:62
GITLAB_TOKEN
• Optional GITLAB_TOKEN: string
User or bot gitlab token, that have access rights for creating merge requests and commiting to protected branches
Defined in
packages/pvm-types/lib/env-schema.ts:210
GITLAB_USER_EMAIL
• Optional GITLAB_USER_EMAIL: string
Email of gitlab user, who start's publish pipeline
Defined in
packages/pvm-types/lib/env-schema.ts:216
GIT_DEPTH
• Optional GIT_DEPTH: string
Gitlab specific. Amount of commits that are fetching in CI environment. Useful when amount commits between releases is big enough ' + 'that previous release falls outside of fetched commits count.
Defined in
packages/pvm-types/lib/env-schema.ts:144
GIT_SSH_PRIV_KEY
• Optional GIT_SSH_PRIV_KEY: string
SSH private key to push to vcs platform from CI via git
Defined in
packages/pvm-types/lib/env-schema.ts:164
GL_TOKEN
• Optional GL_TOKEN: string
see GITLAB_TOKEN
Defined in
packages/pvm-types/lib/env-schema.ts:212
NPM_TOKEN
• Optional NPM_TOKEN: string
NPM registry token with publish access
Defined in
packages/pvm-types/lib/env-schema.ts:168
PVM_CONFIG_SEARCH_FROM
• Optional PVM_CONFIG_SEARCH_FROM: string
What directory pvm config to search from. Default is current working directory.
Defined in
packages/pvm-types/lib/env-schema.ts:126
PVM_DIRECT_GIT_PUSH
• Optional PVM_DIRECT_GIT_PUSH: string
looks like
deprecated
Defined in
packages/pvm-types/lib/env-schema.ts:131
PVM_EXTERNAL_DRY_RUN
• Optional PVM_EXTERNAL_DRY_RUN: string
Enable dry run mode for all pvm commands who support's it
Defined in
packages/pvm-types/lib/env-schema.ts:106
PVM_FORCE_TEST_PUBLISH
• Optional PVM_FORCE_TEST_PUBLISH: string
Used when we want to do real publish to registry in tests (useful in e2e publish test)
Defined in
packages/pvm-types/lib/env-schema.ts:122
PVM_GITHUB_AUTH_STRATEGY
• Optional PVM_GITHUB_AUTH_STRATEGY: "authApp" | "authToken" | "authAction"
Github authentication strategy. See https://github.com/octokit/authentication-strategies.js/ for more details
Defined in
packages/pvm-types/lib/env-schema.ts:182
PVM_GITHUB_TEST_REPO_TOKEN
• Optional PVM_GITHUB_TEST_REPO_TOKEN: string
Access token for test repo
Defined in
packages/pvm-types/lib/env-schema.ts:160
PVM_LL
• Optional PVM_LL: string
Logging level
Defined in
packages/pvm-types/lib/env-schema.ts:148
PVM_MATTERMOST_INCOMING_WEBHOOK
• Optional PVM_MATTERMOST_INCOMING_WEBHOOK: string
Optional incoming webhook. https://docs.mattermost.com/developer/webhooks-incoming.html. It will be used prior to token if specified
Defined in
packages/pvm-types/lib/env-schema.ts:56
PVM_MATTERMOST_TEAM
• Optional PVM_MATTERMOST_TEAM: string
If provided than mattermost client will try first to get channel id from team and passed channel and, if failed, then try to use channel as channel_id.
Defined in
packages/pvm-types/lib/env-schema.ts:43
PVM_MATTERMOST_TOKEN
• Optional PVM_MATTERMOST_TOKEN: string
Private access token for mattermost. Can be bot or regular user token
Defined in
packages/pvm-types/lib/env-schema.ts:47
PVM_MATTERMOST_URL
• Optional PVM_MATTERMOST_URL: string
Mattermost endpoint url. Will be postfixed with api method path
Defined in
packages/pvm-types/lib/env-schema.ts:51
PVM_NO_GIT_FETCH
• Optional PVM_NO_GIT_FETCH: "true" | "false"
Disable default get fetch call before pvm starts work when in CI
Defined in
packages/pvm-types/lib/env-schema.ts:156
PVM_OUTPUT_ALL_RUN_SHELL_COMMANDS
• Optional PVM_OUTPUT_ALL_RUN_SHELL_COMMANDS: string
Log out all shell commands
Defined in
packages/pvm-types/lib/env-schema.ts:110
PVM_PLATFORM_TYPE
• Optional PVM_PLATFORM_TYPE: string
Manually set vcs platform type (gitlab or github)
Defined in
packages/pvm-types/lib/env-schema.ts:139
PVM_SLACK_API_URL
• Optional PVM_SLACK_API_URL: string
see SLACK_API_URL
Defined in
packages/pvm-types/lib/env-schema.ts:38
PVM_SLACK_TOKEN
• Optional PVM_SLACK_TOKEN: string
see SLACK_TOKEN
Defined in
packages/pvm-types/lib/env-schema.ts:14
PVM_SLACK_WEBHOOK
• Optional PVM_SLACK_WEBHOOK: string
see SLACK_WEBHOOK
Defined in
packages/pvm-types/lib/env-schema.ts:30
PVM_SLACK_WEBHOOK_URL
• Optional PVM_SLACK_WEBHOOK_URL: string
see SLACK_WEBHOOK_URL
Defined in
packages/pvm-types/lib/env-schema.ts:22
PVM_TESTING_ENV
• Optional PVM_TESTING_ENV: string
Flag that pvm running in testing environment
Defined in
packages/pvm-types/lib/env-schema.ts:114
PVM_TEST_DATE_NOW
• Optional PVM_TEST_DATE_NOW: string
Replace current time with provided. Useful in tests.
Defined in
packages/pvm-types/lib/env-schema.ts:118
PVM_VCS_TYPE
• Optional PVM_VCS_TYPE: "git" | "fs"
Manually set vcs type (git or local fs)
Defined in
packages/pvm-types/lib/env-schema.ts:135
SLACK_API_URL
• Optional SLACK_API_URL: string
Slack api server url
Defined in
packages/pvm-types/lib/env-schema.ts:34
SLACK_TOKEN
• Optional SLACK_TOKEN: string
Slack bot token that have post message access in target channel
Defined in
packages/pvm-types/lib/env-schema.ts:10
SLACK_WEBHOOK
• Optional SLACK_WEBHOOK: string
deprecated use SLACK_TOKEN instead
Defined in
packages/pvm-types/lib/env-schema.ts:26
SLACK_WEBHOOK_URL
• Optional SLACK_WEBHOOK_URL: string
deprecated use SLACK_TOKEN instead
Defined in
packages/pvm-types/lib/env-schema.ts:18
STOP_AT
• Optional STOP_AT: string
Set lower commits bound when generating fresh releases list