release-please-config.json (SchemaStore) JSON Schema

Type	object
File match	`release-please-config.json`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/release-please-config-json/latest.json
Source	https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Schema for defining manifest config file

Properties

$schema

packages

bootstrap-sha

last-release-sha

always-link-local

plugins

signoff

group-pull-request-title-pattern

release-search-depth

commit-search-depth

commit-batch-size

sequential-calls

release-type

bump-minor-pre-major

bump-patch-for-minor-pre-major

versioning

changelog-sections

release-as

skip-github-release

skip-changelog

draft

force-tag-creation

prerelease

draft-pull-request

label

release-label

extra-label

include-component-in-tag

include-v-in-tag

include-v-in-release-name

changelog-type

changelog-host

changelog-path

pull-request-title-pattern

pull-request-header

separate-pull-requests

always-update

tag-separator

date-format

extra-files

version-file

snapshot-label

initial-version

exclude-paths

component-no-space

All of

1. ReleaserConfigOptions object

2. object object

packages Record<string, object> required

Per-path component configuration.

$schema string

Path to the release-please manifest config schema

format=uri-reference

bootstrap-sha string

For the initial release of a library, only consider as far back as this commit SHA. This is an uncommon use case and should generally be avoided.

last-release-sha string

For any release, only consider as far back as this commit SHA. This is an uncommon use case and should generally be avoided.

always-link-local boolean

When using the node-workspace plugin, force all local dependencies to be linked.

Plugins to apply to pull requests. Plugins can be added to perform extra release processing that cannot be achieved by an individual release strategy.

signoff string

Text to be used as Signed-off-by in the commit.

group-pull-request-title-pattern string

When grouping multiple release pull requests use this pattern for the title.

release-search-depth number

When considering previously releases, only look this deep.

commit-search-depth number

When considering commit history, only look this many commits deep.

commit-batch-size number

Number of commits to fetch per API request when searching commit history. Lower values result in more API calls but may help avoid timeouts. Defaults to 10.

sequential-calls boolean

Whether to open pull requests/releases sequentially rather than concurrently. If you have many components, you may want to set this to avoid secondary rate limits.

label string

Comma-separated list of labels to add to newly opened pull request. These are used to identify release pull requests.

release-label string

Comma-separated list of labels to add to a pull request that has been released/tagged

component-no-space boolean

release-please automatically adds (space) in front of parsed ${component}. This option indicates whether that behaviour should be disabled. Defaults to false

Definitions

ReleaserConfigOptions object

release-type string

The strategy to use for this component.

bump-minor-pre-major boolean

Breaking changes only bump semver minor if version < 1.0.0

bump-patch-for-minor-pre-major boolean

Feature changes only bump semver patch if version < 1.0.0

prerelease-type string

Configuration option for the prerelease versioning strategy. If prerelease strategy used and type set, will set the prerelease part of the version to the provided value in case prerelease part is not present.

versioning string

Versioning strategy. Defaults to default

changelog-sections object[]

Override the Changelog configuration sections

release-as string

[DEPRECATED] Override the next version of this package. Consider using a Release-As commit instead.

skip-github-release boolean

Skip tagging GitHub releases for this package. Release-Please still requires releases to be tagged, so this option should only be used if you have existing infrastructure to tag these releases.Defaults to false.

skip-changelog boolean

Skip generating a changelog for this package. Defaults to false.

draft boolean

Create the GitHub release in draft mode. Defaults to false.

force-tag-creation boolean

Force the creation of a Git tag for the release. This is particularly useful when draft is enabled, because GitHub does not create a Git tag for draft releases until they are published. This 'lazy tag creation' causes release-please to fail to find the previous release, potentially generating incorrect changelogs. Setting this to true ensures the tag is created immediately. Defaults to false.

prerelease boolean

Create the GitHub release as prerelease. Defaults to false.

draft-pull-request boolean

Open the release pull request in draft mode. Defaults to false.

extra-label string

Comma-separated list of labels to add to a newly opened pull request

include-component-in-tag boolean

When tagging a release, include the component name as part of the tag. Defaults to true.

include-v-in-tag boolean

When tagging a release, include v in the tag. Defaults to true.

include-v-in-release-name boolean

Include v in the GitHub release name. Defaults to true.

changelog-type string

The type of changelog to use. Defaults to default.

Values: "default" "github"

changelog-host string

Generate changelog links to this GitHub host. Useful for running against GitHub Enterprise.

changelog-path string

Path to the file that tracks release note changes. Defaults to CHANGELOG.md.

pull-request-title-pattern string

Customize the release pull request title.

pull-request-header string

Customize the release pull request header.

pull-request-footer string

Customize the release pull request footer.

separate-pull-requests boolean

Open a separate release pull request for each component. Defaults to false.

always-update boolean

Always update the pull request with the latest changes. Defaults to false.

tag-separator string

Customize the separator between the component and version in the GitHub tag.

date-format string

Date format given as a strftime expression for the generic strategy.

extra-files string | object | object | object | object[]

Specify extra generic files to replace versions.

exclude-paths string[]

Path of commits to be excluded from parsing. If all files from commit belong to one of the paths it will be skipped

version-file string

Path to the specialize version file. Used by ruby and simple strategies.

snapshot-label string

Label to add to snapshot pull request. Used by java strategies.

skip-snapshot boolean

If set, do not propose snapshot pull requests. Used by java strategies.

initial-version string

Releases the initial library with a specified version

component-no-space boolean

release-please automatically adds (space) in front of parsed ${component}. This option indicates whether that behaviour should be disabled. Defaults to false