Skip to content

Commit

Permalink
Update diagnose URLs in output and docs (#968)
Browse files Browse the repository at this point in the history
Make sure we point to the right page for the diagnose command line tool.

Fixes appsignal/support#301
  • Loading branch information
tombruijn authored Dec 6, 2023
1 parent d29e5a1 commit 72e9e73
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 8 deletions.
6 changes: 6 additions & 0 deletions .changesets/update-diagnose-tool-urls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
bump: "patch"
type: "fix"
---

Update the diagnose tool URLs printed by the CLI and package to the new location in our documentation.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/__tests__/extension.failure.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ describe("Extension", () => {
require("../extension")

expect(errorSpy).toHaveBeenLastCalledWith(
"[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at [email protected]: https://docs.appsignal.com/nodejs/command-line/diagnose.html\n",
"[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at [email protected]: https://docs.appsignal.com/nodejs/3.x/command-line/diagnose.html\n",
expect.any(Object)
)
})
Expand Down Expand Up @@ -89,7 +89,7 @@ describe("Extension", () => {
expect.any(Object)
)
expect(errorSpy).toHaveBeenLastCalledWith(
"[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at [email protected]: https://docs.appsignal.com/nodejs/command-line/diagnose.html\n",
"[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at [email protected]: https://docs.appsignal.com/nodejs/3.x/command-line/diagnose.html\n",
expect.any(Object)
)
})
Expand Down
4 changes: 3 additions & 1 deletion src/cli/diagnose.ts
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,9 @@ export class Diagnose {
this.print_newline()

console.log(`Read more about how the diagnose config output is rendered`)
console.log(`https://docs.appsignal.com/nodejs/command-line/diagnose.html`)
console.log(
`https://docs.appsignal.com/nodejs/3.x/command-line/diagnose.html`
)

this.print_newline()

Expand Down
2 changes: 1 addition & 1 deletion src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ export class Client {
/**
* Internal private function used by the demo CLI.
*
* https://docs.appsignal.com/nodejs/command-line/demo.html
* https://docs.appsignal.com/nodejs/3.x/command-line/demo.html
*
* @private
*/
Expand Down
2 changes: 1 addition & 1 deletion src/extension_wrapper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ try {
)
} else {
console.error(
"[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at [email protected]: https://docs.appsignal.com/nodejs/command-line/diagnose.html\n",
"[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at [email protected]: https://docs.appsignal.com/nodejs/3.x/command-line/diagnose.html\n",
error
)
}
Expand Down
2 changes: 1 addition & 1 deletion test/integration/diagnose

0 comments on commit 72e9e73

Please sign in to comment.