@release-change/cli 0.1.4 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +10 -10
  2. package/dist/constants.d.ts +1 -1
  3. package/dist/constants.js +1 -1
  4. package/dist/show-help.js +1 -1
  5. package/dist/show-help.js.map +1 -1
  6. package/package.json +6 -6
package/README.md CHANGED
@@ -4,8 +4,8 @@ Fully automated version management, changelog management and package publishing
4
4
 
5
5
  ![License: MIT](https://img.shields.io/github/license/release-change/release-change)
6
6
  [![ESM-only package](https://img.shields.io/badge/package-ESM--only-ffe536)](https://nodejs.org/api/esm.html)
7
- [![Conventional Commits 1.0.0](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
8
- [![Formatted with Biome](https://img.shields.io/badge/Formatted_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev/)
7
+ [![Conventional Commits 1.0.0](https://img.shields.io/badge/Conventional_Commits-1.0.0-fe5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
8
+ [![Checked with Biome](https://img.shields.io/badge/Checked_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev)
9
9
  ![NPM latest version](https://img.shields.io/npm/v/%40release-change%2Fcli/latest)
10
10
  ![Node support](https://img.shields.io/node/v/%40release-change%2Fcli)
11
11
  ![Build status](https://img.shields.io/github/actions/workflow/status/release-change/release-change/run-tests.yml)
@@ -32,7 +32,7 @@ It is meant to be integrated in a CI environment. For each new commit added to o
32
32
  To use release-change, you need:
33
33
  - to host your code in a GitHub repository,
34
34
  - to use GitHub Actions,
35
- - Git 2.48.1+,
35
+ - Git 2.23.0+,
36
36
  - a [Node.js](https://nodejs.org) which meets the [version requirements](../../SECURITY.md#supported-nodejs-versions),
37
37
  - a package manager which meets the [version requirements](../../SECURITY.md#supported-package-manager-versions).
38
38
 
@@ -51,11 +51,11 @@ npm install --save-dev @release-change/cli
51
51
 
52
52
  Use the following command to run release-change in the CI environment:
53
53
  ```
54
- pnpx release-change
54
+ pnpx @release-change/cli
55
55
  ```
56
56
  If you are using `npm`:
57
57
  ```
58
- npx release-change
58
+ npx @release-change/cli
59
59
  ```
60
60
 
61
61
  ## Documentation
@@ -108,7 +108,7 @@ Here are examples of the workflow configuration (the file must be saved in the `
108
108
  ISSUE_PR_TOKEN: ${{ secrets.GITHUB_TOKEN }} # to be able to comment on issues and pull requests, close issues and tag pull requests using the GitHub Actions bot
109
109
  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
110
110
  NPM_CONFIG_PROVENANCE: true # to be able to publish to NPM with provenance
111
- run: pnpx release-change
111
+ run: pnpx @release-change/cli
112
112
  ```
113
113
  - using `npm`:
114
114
  ```yaml
@@ -149,7 +149,7 @@ Here are examples of the workflow configuration (the file must be saved in the `
149
149
  ISSUE_PR_TOKEN: ${{ secrets.GITHUB_TOKEN }} # to be able to comment on issues and pull requests, close issues and tag pull requests using the GitHub Actions bot
150
150
  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
151
151
  NPM_CONFIG_PROVENANCE: true # to be able to publish to NPM with provenance
152
- run: npx release-change
152
+ run: npx @release-change/cli
153
153
  ```
154
154
 
155
155
  ### Configuration
@@ -178,7 +178,7 @@ The following examples are the same:
178
178
 
179
179
  Type: `array`
180
180
  Default: `["alpha", "beta", "main", "master", "next"]`
181
- CLI arguments: `-b`, `--branches`
181
+ CLI arguments: `-b <space-separated branches>`, `--branches <space-separated branches>`
182
182
 
183
183
  The branches on which releases should happen.
184
184
 
@@ -186,7 +186,7 @@ The branches on which releases should happen.
186
186
 
187
187
  Type: `string`
188
188
  Default: `repository` property in `package.json` file
189
- CLI arguments: `-r`, `--repository-url`
189
+ CLI arguments: `-r <url>`, `--repository-url <url>`
190
190
 
191
191
  The Git repository URL.
192
192
 
@@ -194,7 +194,7 @@ The Git repository URL.
194
194
 
195
195
  Type: `string`
196
196
  Default: `"origin"`
197
- CLI arguments: `--remote-name`
197
+ CLI arguments: `--remote-name <name>`
198
198
 
199
199
  The remote repository name.
200
200
 
package/dist/constants.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export declare const WORKSPACE_VERSION: string;
2
2
  export declare const REQUIRED_NODE_VERSIONS: string;
3
- export declare const GIT_MIN_VERSION = "2.48.1";
3
+ export declare const GIT_MIN_VERSION = "2.23.0";
4
4
  export declare const TAB: string;
5
5
  export declare const AVAILABLE_CLI_OPTIONS: {
6
6
  readonly branches: {
package/dist/constants.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import packageManifest from "../package.json" with { type: "json" };
2
2
  export const WORKSPACE_VERSION = packageManifest.version;
3
3
  export const REQUIRED_NODE_VERSIONS = packageManifest.engines.node;
4
- export const GIT_MIN_VERSION = "2.48.1";
4
+ export const GIT_MIN_VERSION = "2.23.0";
5
5
  export const TAB = " ".repeat(2);
6
6
  export const AVAILABLE_CLI_OPTIONS = {
7
7
  branches: {
package/dist/show-help.js CHANGED
@@ -8,7 +8,7 @@ import { TAB } from "./constants.js";
8
8
  export const showHelp = () => {
9
9
  const logger = setLogger();
10
10
  const intro = "Runs automated package release and publishing";
11
- const usage = `Usage:\n${TAB}${WORKSPACE_NAME} [options]`;
11
+ const usage = `Usage:\n${TAB}@${WORKSPACE_NAME}/cli [options]`;
12
12
  const cliOptions = displayCliOptions();
13
13
  const output = [intro, usage, cliOptions].join("\n".repeat(2));
14
14
  logger.logWithoutFormatting(output);
package/dist/show-help.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"show-help.js","sourceRoot":"","sources":["../src/show-help.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAS,EAAE;IACjC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAG,+CAA+C,CAAC;IAC9D,MAAM,KAAK,GAAG,WAAW,GAAG,GAAG,cAAc,YAAY,CAAC;IAC1D,MAAM,UAAU,GAAG,iBAAiB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC"}
1
+ {"version":3,"file":"show-help.js","sourceRoot":"","sources":["../src/show-help.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAS,EAAE;IACjC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAG,+CAA+C,CAAC;IAC9D,MAAM,KAAK,GAAG,WAAW,GAAG,IAAI,cAAc,gBAAgB,CAAC;IAC/D,MAAM,UAAU,GAAG,iBAAiB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;AACtC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@release-change/cli",
3
- "version": "0.1.4",
3
+ "version": "0.2.0",
4
4
  "description": "Fully automated version management, changelog management and package publishing with a focus on monorepos, pre-releases and major version zero",
5
5
  "keywords": [
6
6
  "automation",
@@ -47,18 +47,18 @@
47
47
  "engines": {
48
48
  "node": "^20.18.3 || ^22.12.0 || ^24.0.0",
49
49
  "npm": ">=10.8.2",
50
- "pnpm": ">=10.28.0"
50
+ "pnpm": ">=10.30.2"
51
51
  },
52
52
  "dependencies": {
53
53
  "@release-change/ci": "0.1.2",
54
+ "@release-change/commit-analyser": "0.1.3",
54
55
  "@release-change/config": "0.1.2",
55
56
  "@release-change/git": "0.1.4",
56
57
  "@release-change/get-packages": "0.1.2",
57
- "@release-change/commit-analyser": "0.1.3",
58
- "@release-change/github": "0.1.3",
59
- "@release-change/logger": "0.1.2",
60
- "@release-change/release": "0.1.4",
58
+ "@release-change/github": "0.1.4",
61
59
  "@release-change/semver": "0.1.0",
60
+ "@release-change/release": "0.1.5",
61
+ "@release-change/logger": "0.1.2",
62
62
  "@release-change/shared": "0.1.2"
63
63
  },
64
64
  "scripts": {