Skip to content

Conversation

@JorTurFer
Copy link

@JorTurFer JorTurFer commented Nov 3, 2025

As we have discussed via slack, to reduce client_golang dependencies from common pkg and its deps just used for examples, the places where they are used are commented with a note explaining how to run the examples.

This reduces the direct and indirect dependencies of client_golang

Related to prometheus/common#862

@JorTurFer JorTurFer changed the title chore: Comment auth examples to get rid of common pkg deps chore: Comment auth examples to reduce common pkg deps Nov 3, 2025
Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

Thanks!

I am afraid this switch to non-buildable documentation while reusing exemple for the purpose of allowing one less "indirect testing dep" kind of defies the point of using example framework at this point.

We have a few options:
a) Leave the import on this example (close this PR) and live with new "testing indirect dep". I double checked with @dashpole and our tests confirms - we don't see a leak on importer side.
b) Move examples to commentary (e.g. doc.go, hard to ensure they are up to date.)
c) Move examples to different module (hard to discover)

Understanding the whole problem space, I think I'm ok with "a" =D

WDYT?

@JorTurFer
Copy link
Author

Let me try to solve it moving that example to other folder. Maybe if I move that file to the current examples folder, I can create a submodule there.

@JorTurFer JorTurFer closed this Nov 4, 2025
@JorTurFer
Copy link
Author

I close this as we discussed via slack

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants