From f3e5bcd02223852a700b213144fbe9450459c55a Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Thu, 28 Mar 2024 20:18:19 +0000 Subject: [PATCH] chore(release): 4.7.1 [skip ci] --- CHANGELOG.md | 6 ++++++ docs/generate.md | 6 +++--- docs/manifest.md | 2 +- docs/pack.md | 18 ++++++++++++++---- docs/promote.md | 2 +- docs/readme.md | 2 +- docs/upload.md | 8 ++++---- package.json | 2 +- 8 files changed, 31 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d2f53cfde..504a50b48 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [4.7.1](https://github.com/oclif/oclif/compare/4.7.0...4.7.1) (2024-03-28) + +### Bug Fixes + +- doc pretarball in help ([#1348](https://github.com/oclif/oclif/issues/1348)) ([f554696](https://github.com/oclif/oclif/commit/f554696c66fc2adb6d9121be0f52a8b31b2289aa)) + # [4.7.0](https://github.com/oclif/oclif/compare/4.6.3...4.7.0) (2024-03-26) ### Features diff --git a/docs/generate.md b/docs/generate.md index c2ec133aa..8867c734d 100644 --- a/docs/generate.md +++ b/docs/generate.md @@ -60,7 +60,7 @@ EXAMPLES $ oclif generate my-cli --module-type CommonJS --author "John Doe" --yes ``` -_See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/generate.ts)_ +_See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/generate.ts)_ ## `oclif generate command NAME` @@ -81,7 +81,7 @@ DESCRIPTION Add a command to an existing CLI or plugin. ``` -_See code: [src/commands/generate/command.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/generate/command.ts)_ +_See code: [src/commands/generate/command.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/generate/command.ts)_ ## `oclif generate hook NAME` @@ -102,4 +102,4 @@ DESCRIPTION Add a hook to an existing CLI or plugin. ``` -_See code: [src/commands/generate/hook.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/generate/hook.ts)_ +_See code: [src/commands/generate/hook.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/generate/hook.ts)_ diff --git a/docs/manifest.md b/docs/manifest.md index 64f2d8585..1a64146a8 100644 --- a/docs/manifest.md +++ b/docs/manifest.md @@ -22,4 +22,4 @@ DESCRIPTION Generates plugin manifest json (oclif.manifest.json). ``` -_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/manifest.ts)_ +_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/manifest.ts)_ diff --git a/docs/pack.md b/docs/pack.md index e82e3910c..610c0d91e 100644 --- a/docs/pack.md +++ b/docs/pack.md @@ -24,13 +24,15 @@ FLAGS DESCRIPTION Pack CLI into debian package. + Add a pretarball script to your package.json if you need to run any scripts before the tarball is created. + FLAG DESCRIPTIONS -z, --compression=gzip|none|xz|zstd Override the default compression used by dpkg-deb. For more details see the `-Zcompress-type` section at https://man7.org/linux/man-pages/man1/dpkg-deb.1.html ``` -_See code: [src/commands/pack/deb.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/pack/deb.ts)_ +_See code: [src/commands/pack/deb.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/pack/deb.ts)_ ## `oclif pack macos` @@ -47,9 +49,11 @@ FLAGS DESCRIPTION Pack CLI into macOS .pkg + + Add a pretarball script to your package.json if you need to run any scripts before the tarball is created. ``` -_See code: [src/commands/pack/macos.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/pack/macos.ts)_ +_See code: [src/commands/pack/macos.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/pack/macos.ts)_ ## `oclif pack tarballs` @@ -70,9 +74,11 @@ DESCRIPTION Package oclif CLI into tarballs. This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary. + + Add a pretarball script to your package.json if you need to run any scripts before the tarball is created. ``` -_See code: [src/commands/pack/tarballs.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/pack/tarballs.ts)_ +_See code: [src/commands/pack/tarballs.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/pack/tarballs.ts)_ ## `oclif pack win` @@ -93,10 +99,14 @@ FLAGS DESCRIPTION Create windows installer from oclif CLI + You need to have 7zip, nsis (makensis), and grep installed on your machine in order to run this command. + This command will produce unsigned installers unless you supply WINDOWS_SIGNING_PASS (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) in the environment and have set the windows.name and windows.keypath properties in your package.json's oclif property. + Add a pretarball script to your package.json if you need to run any scripts before the tarball is created. + FLAG DESCRIPTIONS --defender-exclusion=checked|unchecked|hidden @@ -106,4 +116,4 @@ FLAG DESCRIPTIONS There is no way to set a hidden checkbox with "true" as a default...the user can always allow full security ``` -_See code: [src/commands/pack/win.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/pack/win.ts)_ +_See code: [src/commands/pack/win.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/pack/win.ts)_ diff --git a/docs/promote.md b/docs/promote.md index 9018b5d09..ee8ad6065 100644 --- a/docs/promote.md +++ b/docs/promote.md @@ -30,4 +30,4 @@ DESCRIPTION Promote CLI builds to a S3 release channel. ``` -_See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/promote.ts)_ +_See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/promote.ts)_ diff --git a/docs/readme.md b/docs/readme.md index 329183913..eef0a883f 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -37,4 +37,4 @@ DESCRIPTION Customize the code URL prefix by setting oclif.repositoryPrefix in package.json. ``` -_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/readme.ts)_ +_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/readme.ts)_ diff --git a/docs/upload.md b/docs/upload.md index ca7d1c189..30fccae5a 100644 --- a/docs/upload.md +++ b/docs/upload.md @@ -22,7 +22,7 @@ DESCRIPTION Upload deb package built with `pack deb`. ``` -_See code: [src/commands/upload/deb.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/upload/deb.ts)_ +_See code: [src/commands/upload/deb.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/upload/deb.ts)_ ## `oclif upload macos` @@ -40,7 +40,7 @@ DESCRIPTION Upload macos installers built with `pack macos`. ``` -_See code: [src/commands/upload/macos.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/upload/macos.ts)_ +_See code: [src/commands/upload/macos.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/upload/macos.ts)_ ## `oclif upload tarballs` @@ -59,7 +59,7 @@ DESCRIPTION Upload an oclif CLI to S3. ``` -_See code: [src/commands/upload/tarballs.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/upload/tarballs.ts)_ +_See code: [src/commands/upload/tarballs.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/upload/tarballs.ts)_ ## `oclif upload win` @@ -77,4 +77,4 @@ DESCRIPTION Upload windows installers built with `pack win`. ``` -_See code: [src/commands/upload/win.ts](https://github.com/oclif/oclif/blob/4.7.0/src/commands/upload/win.ts)_ +_See code: [src/commands/upload/win.ts](https://github.com/oclif/oclif/blob/4.7.1/src/commands/upload/win.ts)_ diff --git a/package.json b/package.json index 0a83b6775..7f4a3d07b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "oclif", "description": "oclif: create your own CLI", - "version": "4.7.0", + "version": "4.7.1", "author": "Salesforce", "bin": { "oclif": "bin/run.js"