Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@types/semantic-release
Advanced tools
@types/semantic-release - npm Package Compare versions
Comparing version 15.13.1 to 17.0.0
@@ -1,2 +0,2 @@ | ||
| // Type definitions for semantic-release 15.13 | ||
| // Type definitions for semantic-release 17.0 | ||
| // Project: https://github.com/semantic-release/semantic-release#readme | ||
@@ -19,13 +19,67 @@ // Definitions by: Leonardo Gatica <https://github.com/lgaticaq> | ||
| /** | ||
| * The branch on which releases should happen. | ||
| * List of modules or file paths containing a | ||
| * [shareable configuration](https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations). | ||
| * If multiple shareable configurations are set, they will be imported | ||
| * in the order defined with each configuration option taking | ||
| * precedence over the options defined in a previous shareable | ||
| * configuration. | ||
| * | ||
| * **Note**: Options defined via CLI arguments or in the configuration | ||
| * file will take precedence over the ones defined in any shareable | ||
| * configuration. | ||
| */ | ||
| branch?: string; | ||
| extends?: ReadonlyArray<string> | string; | ||
| /** | ||
| * The Git repository URL, in any supported format. | ||
| * The branches on which releases should happen. By default | ||
| * **semantic-release** will release: | ||
| * | ||
| * * regular releases to the default distribution channel from the | ||
| * branch `master` | ||
| * * regular releases to a distribution channel matching the branch | ||
| * name from any existing branch with a name matching a maintenance | ||
| * release range (`N.N.x` or `N.x.x` or `N.x` with `N` being a | ||
| * number) | ||
| * * regular releases to the `next` distribution channel from the | ||
| * branch `next` if it exists | ||
| * * regular releases to the `next-major` distribution channel from | ||
| * the branch `next-major` if it exists. | ||
| * * prereleases to the `beta` distribution channel from the branch | ||
| * `beta` if it exists | ||
| * * prereleases to the `alpha` distribution channel from the branch | ||
| * `alpha` if it exists | ||
| * | ||
| * **Note**: If your repository does not have a release branch, then | ||
| * **semantic-release** will fail with an `ERELEASEBRANCHES` error | ||
| * message. If you are using the default configuration, you can fix | ||
| * this error by pushing a `master` branch. | ||
| * | ||
| * **Note**: Once **semantic-release** is configured, any user with the | ||
| * permission to push commits on one of those branches will be able to | ||
| * publish a release. It is recommended to protect those branches, for | ||
| * example with [GitHub protected branches](https://help.github.com/articles/about-protected-branches). | ||
| * | ||
| * See [Workflow configuration](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#workflow-configuration) | ||
| * for more details. | ||
| */ | ||
| branches?: ReadonlyArray<BranchSpec> | BranchSpec; | ||
| /** | ||
| * The git repository URL. | ||
| * | ||
| * Any valid git url format is supported (see | ||
| * [git protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols)) | ||
| * | ||
| * Default: `repository` property in `package.json`, or git origin url. | ||
| */ | ||
| repositoryUrl?: string; | ||
| /** | ||
| * The Git tag format used by semantic-release to identify releases. | ||
| * The git tag format used by **semantic-release** to identify | ||
| * releases. The tag name is generated with [Lodash template](https://lodash.com/docs#template) | ||
| * and will be compiled with the `version` variable. | ||
| * | ||
| * **Note**: The `tagFormat` must contain the `version` variable | ||
| * exactly once and compile to a | ||
| * [valid git reference](https://git-scm.com/docs/git-check-ref-format#_description). | ||
| */ | ||
@@ -35,10 +89,18 @@ tagFormat?: string; | ||
| /** | ||
| * Specifies the list of plugins to use. Plugins will run in series, in | ||
| * the order specified. | ||
| * Define the list of plugins to use. Plugins will run in series, in | ||
| * the order defined, for each [step](https://semantic-release.gitbook.io/semantic-release/#release-steps) | ||
| * if they implement it. | ||
| * | ||
| * If this option is not specified, then semantic-release will use a | ||
| * default list of plugins. | ||
| * Plugins configuration can be defined by wrapping the name and an | ||
| * options object in an array. | ||
| * | ||
| * Configuration options for each plugin can be defined by wrapping the | ||
| * name and an options object in an array. | ||
| * See [Plugins configuration](https://semantic-release.gitbook.io/semantic-release/usage/plugins#plugins) | ||
| * for more details. | ||
| * | ||
| * Default: `[ | ||
| * "@semantic-release/commit-analyzer", | ||
| * "@semantic-release/release-notes-generator", | ||
| * "@semantic-release/npm", | ||
| * "@semantic-release/github" | ||
| * ]` | ||
| */ | ||
@@ -70,8 +132,42 @@ plugins?: ReadonlyArray<PluginSpec>; | ||
| /** | ||
| * The branch on which releases should happen. | ||
| * The branches on which releases should happen. By default | ||
| * **semantic-release** will release: | ||
| * | ||
| * * regular releases to the default distribution channel from the | ||
| * branch `master` | ||
| * * regular releases to a distribution channel matching the branch | ||
| * name from any existing branch with a name matching a maintenance | ||
| * release range (`N.N.x` or `N.x.x` or `N.x` with `N` being a | ||
| * number) | ||
| * * regular releases to the `next` distribution channel from the | ||
| * branch `next` if it exists | ||
| * * regular releases to the `next-major` distribution channel from | ||
| * the branch `next-major` if it exists. | ||
| * * prereleases to the `beta` distribution channel from the branch | ||
| * `beta` if it exists | ||
| * * prereleases to the `alpha` distribution channel from the branch | ||
| * `alpha` if it exists | ||
| * | ||
| * **Note**: If your repository does not have a release branch, then | ||
| * **semantic-release** will fail with an `ERELEASEBRANCHES` error | ||
| * message. If you are using the default configuration, you can fix | ||
| * this error by pushing a `master` branch. | ||
| * | ||
| * **Note**: Once **semantic-release** is configured, any user with the | ||
| * permission to push commits on one of those branches will be able to | ||
| * publish a release. It is recommended to protect those branches, for | ||
| * example with [GitHub protected branches](https://help.github.com/articles/about-protected-branches). | ||
| * | ||
| * See [Workflow configuration](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#workflow-configuration) | ||
| * for more details. | ||
| */ | ||
| branch: string; | ||
| branches: ReadonlyArray<BranchSpec> | BranchSpec; | ||
| /** | ||
| * The Git repository URL, in any supported format. | ||
| * The git repository URL. | ||
| * | ||
| * Any valid git url format is supported (see | ||
| * [git protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols)) | ||
| * | ||
| * Default: `repository` property in `package.json`, or git origin url. | ||
| */ | ||
@@ -81,3 +177,9 @@ repositoryUrl: string; | ||
| /** | ||
| * The Git tag format used by semantic-release to identify releases. | ||
| * The git tag format used by **semantic-release** to identify | ||
| * releases. The tag name is generated with [Lodash template](https://lodash.com/docs#template) | ||
| * and will be compiled with the `version` variable. | ||
| * | ||
| * **Note**: The `tagFormat` must contain the `version` variable | ||
| * exactly once and compile to a | ||
| * [valid git reference](https://git-scm.com/docs/git-check-ref-format#_description). | ||
| */ | ||
@@ -87,10 +189,18 @@ tagFormat: string; | ||
| /** | ||
| * Specifies the list of plugins to use. Plugins will run in series, in | ||
| * the order specified. | ||
| * Define the list of plugins to use. Plugins will run in series, in | ||
| * the order defined, for each [step](https://semantic-release.gitbook.io/semantic-release/#release-steps) | ||
| * if they implement it. | ||
| * | ||
| * If this option is not specified, then semantic-release will use a | ||
| * default list of plugins. | ||
| * Plugins configuration can be defined by wrapping the name and an | ||
| * options object in an array. | ||
| * | ||
| * Configuration options for each plugin can be defined by wrapping the | ||
| * name and an options object in an array. | ||
| * See [Plugins configuration](https://semantic-release.gitbook.io/semantic-release/usage/plugins#plugins) | ||
| * for more details. | ||
| * | ||
| * Default: `[ | ||
| * "@semantic-release/commit-analyzer", | ||
| * "@semantic-release/release-notes-generator", | ||
| * "@semantic-release/npm", | ||
| * "@semantic-release/github" | ||
| * ]` | ||
| */ | ||
@@ -101,2 +211,87 @@ plugins: ReadonlyArray<PluginSpec>; | ||
| /** | ||
| * Specifies a git branch holding commits to analyze and code to release. | ||
| * | ||
| * Each branch may be defined either by a string or an object. Specifying | ||
| * a string is a shortcut for specifying that string as the `name` field, | ||
| * for example `"master"` expands to `{name: "master"}`. | ||
| */ | ||
| type BranchSpec = string | { | ||
| /** | ||
| * The name of git branch. | ||
| * | ||
| * A `name` is required for all types of branch. It can be defined as a | ||
| * [glob](https://github.com/micromatch/micromatch#matching-features) | ||
| * in which case the definition will be expanded to one per matching | ||
| * branch existing in the repository. | ||
| * | ||
| * If `name` doesn't match any branch existing in the repository, the | ||
| * definition will be ignored. For example, the default configuration | ||
| * includes the definition `next` and `next-major` which will become | ||
| * active only when the branches `next` and/or `next-major` are | ||
| * created in the repository. | ||
| */ | ||
| name: string; | ||
| /** | ||
| * The distribution channel on which to publish releases from this | ||
| * branch. | ||
| * | ||
| * If this field is set to `false`, then the branch will be released | ||
| * on the default distribution channel (for example the `@latest` | ||
| * [dist-tag](https://docs.npmjs.com/cli/dist-tag) for npm). This is | ||
| * also the default behavior for the first | ||
| * [release branch](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#release-branches) | ||
| * if the channel property is not set. | ||
| * | ||
| * For all other branches, if the channel property is not set, then the | ||
| * channel name will be the same as the branch name. | ||
| * | ||
| * The value of `channel`, if defined as a string, is generated with | ||
| * [Lodash template](https://lodash.com/docs#template) with the | ||
| * variable `name` set to the branch name. | ||
| * | ||
| * For example `{name: 'next', channel: 'channel-${name}'}` will be | ||
| * expanded to `{name: 'next', channel: 'channel-next'}`. | ||
| */ | ||
| channel?: string | false; | ||
| /** | ||
| * The range of [semantic versions](https://semver.org/) to support on | ||
| * this branch. | ||
| * | ||
| * A `range` only applies to maintenance branches and must be formatted | ||
| * like `N.N.x` or `N.x` (`N` is a number). If no range is specified | ||
| * but the `name` is formatted as a range, then the branch will be | ||
| * considered a maintenance branch and the `name` value will be used | ||
| * for the `range`. | ||
| * | ||
| * Required for maintenance branches, unless `name` is formatted like | ||
| * `N.N.x` or `N.x` (`N` is a number). | ||
| */ | ||
| range?: string; | ||
| /** | ||
| * The pre-release identifier to append to [semantic versions](https://semver.org/) | ||
| * released from this branch. | ||
| * | ||
| * A `prerelease` property applies only to pre-release branches and | ||
| * the `prerelease` value must be valid per the [Semantic Versioning | ||
| * Specification](https://semver.org/#spec-item-9). It will determine | ||
| * the name of versions. For example if `prerelease` is set to | ||
| * `"beta"`, the version will be formatted like `2.0.0-beta.1`, | ||
| * `2.0.0-beta.2`, etc. | ||
| * | ||
| * The value of `prerelease`, if defined as a string, is generated with | ||
| * [Lodash template](https://lodash.com/docs#template) with the | ||
| * variable `name` set to the name of the branch. | ||
| * | ||
| * If the `prerelease property is set to `true` then the name of the | ||
| * branch is used as the pre-release identifier. | ||
| * | ||
| * Required for pre-release branches. | ||
| */ | ||
| prerelease?: string; | ||
| }; | ||
| /** | ||
| * Specifies a plugin to use. | ||
@@ -103,0 +298,0 @@ * |
| { | ||
| "name": "@types/semantic-release", | ||
| "version": "15.13.1", | ||
| "version": "17.0.0", | ||
| "description": "TypeScript definitions for semantic-release", | ||
@@ -19,3 +19,3 @@ "license": "MIT", | ||
| "main": "", | ||
| "types": "index", | ||
| "types": "index.d.ts", | ||
| "repository": { | ||
@@ -30,4 +30,4 @@ "type": "git", | ||
| }, | ||
| "typesPublisherContentHash": "d07177b08e42211eb17dad103bf05a7d955756ddfa2a29b996414e5f0ec365c9", | ||
| "typeScriptVersion": "2.0" | ||
| "typesPublisherContentHash": "27c89ed9107e540a9ae1240df9c900042e2d031e3dcd1116acc25d7c43458871", | ||
| "typeScriptVersion": "2.9" | ||
| } |
@@ -8,10 +8,10 @@ # Installation | ||
| # Details | ||
| Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/semantic-release | ||
| Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/semantic-release. | ||
| Additional Details | ||
| * Last updated: Tue, 22 Oct 2019 21:04:40 GMT | ||
| * Dependencies: @types/node | ||
| ### Additional Details | ||
| * Last updated: Fri, 08 May 2020 15:38:05 GMT | ||
| * Dependencies: [@types/node](https://npmjs.com/package/@types/node) | ||
| * Global values: none | ||
| # Credits | ||
| These definitions were written by Leonardo Gatica <https://github.com/lgaticaq>, and Daniel Cassidy <https://github.com/djcsdy>. | ||
| These definitions were written by [Leonardo Gatica](https://github.com/lgaticaq), and [Daniel Cassidy](https://github.com/djcsdy). |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by86.74%
19262
- Lines of code
- increased by57.58%
520
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes