Skip to content

Conversation

@miliberlin
Copy link
Member

@miliberlin miliberlin commented Nov 24, 2025

Affected Components

  • CLI
  • Create CLI
  • Test
  • Docs
  • Examples
  • Other

Notes for the Reviewer

In order to support local development for the GitHub integration project, we need to be able to alter the Checkly base URL.
The GitHub integration flow opens a PR with changes on the user's codebase to add the Checkly CLI and add example GitHub action workflows running the test and deploy commands.
To test this locally, we expose and access the local backend via a tunnel (ngrok, cloudflare etc.), but the API URL is currently hardcoded to localhost and thus can't be accessed from a GH action.

Resolves #[issue-number]

New Dependency Submission

@miliberlin miliberlin added the build Issue regarding building and packaging label Nov 24, 2025
@github-actions

This comment has been minimized.


getApiUrl (): string {
// Allow overriding the API URL via CHECKLY_BASE_URL environment variable
if (process.env.CHECKLY_BASE_URL) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is pretty much only needed for local development. Let me know if you prefer moving this to line 87 as local: process.env.CHECKLY_BASE_URL || 'http://127.0.0.1:3000'.
See the PR description for more context.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we move it to 87 then the user also needs to add the env for local (so 2 envs) this way we override everything by just setting one env 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this works but how about the getMqttUrl below?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sorccu good point! The local MQTT server also needs to be tunneled and the URL overwritten. I haven't worked on this part yet on the FE side. I'll put this PR back into draft until I've tested that fully.

@miliberlin miliberlin marked this pull request as ready for review November 24, 2025 12:46
ferrandiaz
ferrandiaz previously approved these changes Nov 25, 2025
@miliberlin miliberlin marked this pull request as draft November 25, 2025 10:46
@miliberlin miliberlin added build Issue regarding building and packaging and removed build Issue regarding building and packaging labels Nov 25, 2025
@github-actions

This comment has been minimized.

@miliberlin miliberlin added build Issue regarding building and packaging and removed build Issue regarding building and packaging labels Dec 2, 2025
@github-actions
Copy link

github-actions bot commented Dec 2, 2025

🎉 Experimental release successfully published on npm

npm install [email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Issue regarding building and packaging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants