release: cli v4.0.1

Author: barrymichaeldoyle

README.md

@@ -4,6 +4,8 @@
 
 PatchPulse helps you stay on top of npm dependency updates across your projects.
 
+Live docs: https://barrymichaeldoyle.github.io/patch-pulse/
+
 | Tool                                             | Status                          | Description                                              |
 | ------------------------------------------------ | ------------------------------- | -------------------------------------------------------- |
 | [Slack bot](#slack-bot)                          | Live                            | Get notified in Slack when your packages release updates |
@@ -69,6 +71,7 @@ PatchPulse is a `pnpm` monorepo.
 
 Workspace docs:
 
+- [Live docs site](https://barrymichaeldoyle.github.io/patch-pulse/)
 - [Contributing](./CONTRIBUTING.md)
 - [Support](./SUPPORT.md)
 

packages/cli/CHANGELOG.md

@@ -1,5 +1,15 @@
 # patch-pulse
 
+## 4.0.1
+
+### Patch Changes
+
+- Refresh the CLI screenshot and point users to the live docs site from the CLI package.
+  - update the example screenshot in the CLI README/package assets
+  - point the npm package homepage at the published docs site
+  - add the docs site to the CLI help, about, and version output
+  - add explicit docs links in the CLI README
+
 ## 4.0.0
 
 ### Major Changes

packages/cli/README.md

@@ -20,6 +20,8 @@ npx patch-pulse
 
 That's it! Patch Pulse scans the current project for `package.json` files and shows which dependencies are outdated.
 
+Docs: https://barrymichaeldoyle.github.io/patch-pulse/
+
 - Zero runtime dependencies
 - Monorepo-aware, including pnpm `catalog:` support
 - Interactive terminal updates for patch, minor, or all outdated packages
@@ -162,6 +164,7 @@ Get notified in Slack whenever a package you depend on releases a new version.
 
 ## Support
 
+- 📚 **Read the docs** at [barrymichaeldoyle.github.io/patch-pulse](https://barrymichaeldoyle.github.io/patch-pulse/)
 - ⭐ **Star** the repo
 - 🐛 **Report bugs** via [Issues](https://github.com/barrymichaeldoyle/patch-pulse/issues)
 - 💬 **Join discussions** in [Discussions](https://github.com/barrymichaeldoyle/patch-pulse/discussions)

packages/cli/assets/example.png

@@ -1,2 +1,4 @@
 # build output
 dist/
+!dist/
+!dist/package.json

packages/cli/e2e/with-gitignore/fixtures/.gitignore

@@ -0,0 +1,6 @@
+{
+  "name": "dist-build-output",
+  "dependencies": {
+    "react": "^18.2.0"
+  }
+}

packages/cli/e2e/with-gitignore/fixtures/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patch-pulse",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Check for outdated npm dependencies",
   "type": "module",
   "bin": {
@@ -26,7 +26,7 @@
     "name": "Barry Michael Doyle",
     "email": "barry@barrymichaeldoyle.com"
   },
-  "homepage": "https://github.com/barrymichaeldoyle/patch-pulse/tree/main/packages/cli#readme",
+  "homepage": "https://barrymichaeldoyle.github.io/patch-pulse/",
   "bugs": {
     "url": "https://github.com/barrymichaeldoyle/patch-pulse/issues"
   },

packages/cli/package.json

@@ -22,6 +22,7 @@ export const CONFIG_FILENAMES: readonly string[] = [
 ];
 
 const ROOT_REPO_URL = 'https://github.com/barrymichaeldoyle/patch-pulse';
+export const DOCS_URL = 'https://barrymichaeldoyle.github.io/patch-pulse/';
 export const CLI_REPO_URL = `${ROOT_REPO_URL}/tree/main/packages/cli`;
 export const ISSUES_URL = `${ROOT_REPO_URL}/issues`;
 export const SPONSORS_URL = 'https://github.com/sponsors/barrymichaeldoyle';

packages/cli/src/constant.ts

@@ -2,6 +2,7 @@ import { ansi } from '../ansi';
 import { createCenteredBox } from '../createCenteredBox';
 import {
   CLI_REPO_URL,
+  DOCS_URL,
   ISSUES_URL,
   SLACK_BOT_URL,
   SPONSORS_URL,
@@ -14,6 +15,7 @@ ${ansi.white('Patch Pulse checks npm dependency versions across apps and monorep
 ${ansi.white('It keeps the CLI lean: zero runtime dependencies, pnpm catalog support,')}
 ${ansi.white('interactive updates, and now machine-readable output with --json.')}
 
+${ansi.cyanBold('Docs:')}      ${ansi.white(ansi.link('barrymichaeldoyle.github.io/patch-pulse', DOCS_URL))}
 ${ansi.cyanBold('Repo:')}      ${ansi.white(ansi.link('barrymichaeldoyle/patch-pulse', CLI_REPO_URL))}
 ${ansi.cyanBold('Issues:')}    ${ansi.white(ansi.link('Report a bug or request a feature', ISSUES_URL))}
 ${ansi.cyanBold('Sponsors:')}  ${ansi.white(ansi.link('Support development on GitHub Sponsors', SPONSORS_URL))}

packages/cli/src/ui/display/about.ts

@@ -1,6 +1,6 @@
 import { ansi } from '../ansi';
 import { createCenteredBox } from '../createCenteredBox';
-import { CLI_REPO_URL, ISSUES_URL, SLACK_BOT_URL } from '../../constant';
+import { DOCS_URL, ISSUES_URL, SLACK_BOT_URL } from '../../constant';
 import { displayMadeWithLove } from './madeWithLove';
 
 /**
@@ -70,7 +70,7 @@ ${ansi.cyanBoldUnderline('💡 Examples:')}
   ${ansi.white('npx patch-pulse --json --fail')}            ${ansi.gray('# Machine-readable output + non-zero exit for CI scripts')}
 
 ${ansi.cyanBoldUnderline('🔗 Links:')}
-  ${ansi.blue('📚 Docs:')}      ${ansi.white(ansi.link('barrymichaeldoyle/patch-pulse', CLI_REPO_URL))}
+  ${ansi.blue('📚 Docs:')}      ${ansi.white(ansi.link('barrymichaeldoyle.github.io/patch-pulse', DOCS_URL))}
   ${ansi.blue('🐛 Issues:')}    ${ansi.white(ansi.link('Open an issue', ISSUES_URL))}
   ${ansi.blue('👨‍ Author:')}    ${ansi.white(ansi.link('github.com/barrymichaeldoyle', 'https://github.com/barrymichaeldoyle'))}
   ${ansi.blue('🤖 Slack Bot:')} ${ansi.white(ansi.link('Add to Slack', SLACK_BOT_URL))}`);