Uplift
Uplift configuration file
| Type | object |
|---|---|
| File match |
.uplift.yml
.uplift.yaml
uplift.yml
uplift.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/uplift/latest.json |
| Source | https://upliftci.dev/static/schema.json |
Validate with Lintel
npx @lintel/lintel checkA JSON schema for the Uplift configuration file
Properties
Use annotated tags instead of lightweight tags when tagging a new semantic version. An annotated tag is treated like a regular commit by git and contains both author details and a commit message. Uplift will either use its defaults or the custom commit details provided when generating the annotated tag.
Define a series of files whose semantic version will be bumped. Supports both Regex and JSON Path based file bumps
2 nested properties
Name of the commit author
Email of the commit author
Change the default commit message used by Uplift when committing any staged changes. The default commit message is: ci(uplift): uplifted for version v0.1.0
6 nested properties
Change the sort order of the commits within each changelog entry. Supported values are [asc, desc, ASC or DESC]. Defaults to desc (descending order) to mirror the default behaviour of 'git log'
A list of commits to exclude during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be excluded. Auto-generated commits from Uplift (with the prefix ci(uplift)) will always be excluded
A list of commits to cherry-pick and include during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be included
Include multiline commit messages within the changelog. Disables default behaviour of truncating a commit message to its first line
Trims any lines preceding the conventional commit type in the commit message
Skips generating a changelog for any prerelease. All commits from a prerelease will be appended to the changelog entry for the next release
4 nested properties
A flag for suppressing the git detached HEAD repository check. If set to true, Uplift will report a warning while running, otherwise Uplift will raise an error and stop. Defaults to false
A flag for suppressing the git shallow repository check. If set to true, Uplift will report a warning while running, otherwise Uplift will raise an error and stop. Defaults to false
1 nested properties
The URL of the self-hosted instance of Gitea. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository
1 nested properties
The URL of the enterprise instance of GitHub. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository
1 nested properties
The URL of the self-managed instance of GitLab. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository
8 nested properties
Define a set of environment variables that are made available to all hooks. Supports loading environment variables from DotEnv (.env) files. Environment variables are merged with system wide ones.
All of
Definitions
The path of the file relative to where Uplift is executed. Glob patterns can be used to match multiple files at the same time. Glob syntax is based on https://github.com/goreleaser/fileglob
A regex matcher to be used when bumping the file. Multiple regex matches are supported. Each will be carried out in the order they are defined here. All matches must succeed for the file to be bumped
A JSON path matcher to be used when bumping the file. Multiple path matches are supported. Each will be carried out in the order they are defined here. All matches must succeed for the file to be bumped. JSON path syntax is based on https://github.com/tidwall/sjson
A regex pattern for matching and replacing the version within the file.
The number of times any matched version should be replaced
A flag controlling if the matched version in the file should be replaced with a semantic version. This will strip any 'v' prefix if needed
A JSON path for matching and replacing the version within the file
A flag controlling if the matched version in the file should be replaced with a semantic version. This will strip any 'v' prefix if needed
Name of the commit author
Email of the commit author
Change the sort order of the commits within each changelog entry. Supported values are [asc, desc, ASC or DESC]. Defaults to desc (descending order) to mirror the default behaviour of 'git log'
A list of commits to exclude during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be excluded. Auto-generated commits from Uplift (with the prefix ci(uplift)) will always be excluded
A list of commits to cherry-pick and include during the creation of a changelog. Provide a list of regular expressions for matching commits that are to be included
Include multiline commit messages within the changelog. Disables default behaviour of truncating a commit message to its first line
Trims any lines preceding the conventional commit type in the commit message
Skips generating a changelog for any prerelease. All commits from a prerelease will be appended to the changelog entry for the next release
A flag for suppressing the git detached HEAD repository check. If set to true, Uplift will report a warning while running, otherwise Uplift will raise an error and stop. Defaults to false
A flag for suppressing the git shallow repository check. If set to true, Uplift will report a warning while running, otherwise Uplift will raise an error and stop. Defaults to false
The URL of the self-hosted instance of Gitea. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository
The URL of the enterprise instance of GitHub. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository
The URL of the self-managed instance of GitLab. Only the scheme and hostname are required. The hostname is used when matching against the configured remote origin of the cloned repository