misc: move all importable code to internal/ #6552
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rfratto
force-pushed
the
move-code-to-internal
branch
from
cf7803e
to
f7ccdb3
Compare
thampiotr
approved these changes
Feb 29, 2024
rfratto
force-pushed
the
move-code-to-internal
branch
from
25aca36
to
df71df6
Compare
rfratto
force-pushed
the
move-code-to-internal
branch
from
df71df6
to
2b84983
Compare
4 tasks
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our backwards compatibility guarantees cover importable Go code. This applies once we cut the 1.0 release, which we are rapidly approaching.
The Grafana Agent maintainers have agreed that it is more important for 1.0 to focus on stability of the configuration file and usage of the Grafana Agent binaries rather than on the stability of importable code.
This PR moves all importable Go code to
internal/so that it is no longer externally importable. This gives us time to finalize Go APIs without blocking the 1.0 release or removing our commitment to having Go APIs follow semantic versioning. Some time after the 1.0 release, we will have public Go APIs available for consumption.There are some slightly odd artifacts in this PR for the purposes of making sure we have no public Go API surface:
internal/tools:internal/tools/docs_generator.internal/tools/packaging_test.package main) not a part of our release assets have similarly moved tointernal/cmd:internal/cmd/integration-testsinternal/cmd/agentlintinternal/cmd/riverevalwebtointernal/web.I don't know if all of these changes are necessary, or if they have been moved to a sensible location. However, for the scope of this PR, I would like to keep the folders in their new location, and follow-up PRs and discussions can be used to reorganize
internal/as needed.