Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve dev experience with devcontainer and debugger breakpoint support #1127

Closed
wants to merge 9 commits into from

Conversation

OneCyrus
Copy link

this PR adds DevContainer support to simplify the dev environment setup. the devcontainer install all needed dependencies to build and run the plugin.

I also added a debug configuration to easily run the plugin inside the devcontainer.

image

with the added debug configuration comes also the mapping of sourcemaps to the local files. this allows to set breakpoints inside vscode and directly inspect the variables in the typescript code.

image

@OneCyrus OneCyrus requested a review from a team as a code owner January 20, 2025 17:21
@CLAassistant
Copy link

CLAassistant commented Jan 20, 2025

CLA assistant check
All committers have signed the CLA.

@SpencerTorres
Copy link
Collaborator

Hello! Thanks for submitting this PR. There's already some guides/tools in place for Grafana plugin development, I feel like it may confuse contributors to have this added in this form. It adds another dependency, another config to be maintained, and there's also some quirks with how the plugin frontend/backend gets reloaded for code changes. I'm not sure this container solves those workflows the same way as the official guides recommend.

I personally use a direct clone of the Grafana repo and point it to my local plugin fork, it automatically reloads and falls back to the latest plugin binary when I'm not running it in debug mode in my IDE. Same for the frontend. The plugin architecture makes this work surprisingly seamlessly.

@bossinc wdyt? Perhaps I'm being too cautious about adding any new build/dev tools like this

@aangelisc
Copy link
Contributor

Thank you for the comment @SpencerTorres. I concur, we wouldn't be willing to accept this contribution at this time. As we have a standard method of developing our plugins that is consistent across all of them I wouldn't want to introduce a divergent method for ClickHouse.

Thank you for the contribution @OneCyrus but unfortunately we can't accept this at this time 😊

@aangelisc aangelisc closed this Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants