Prototype of auto-generated compatible components section in docs #4753
Conversation
thampiotr
force-pushed
the
thampiotr/prototype-component-x-links
branch
from
19e4ddc
to
7cbf2ab
Compare
| DataTypePyroscopeProfiles = DataType("Pyroscope Profiles") | ||
| ) | ||
|
|
||
| type Metadata struct { |
There was a problem hiding this comment.
Happy to rename this
| return inferMetadata(reg.Args, reg.Exports), nil | ||
| } | ||
|
|
||
| func inferMetadata(args component.Arguments, exports component.Exports) Metadata { |
There was a problem hiding this comment.
Support for more types can be added in this function, which is also easy to test and make sure we don't get unexpected relationships.
|
|
||
| var fixTestsFlag = flag.Bool("fix-tests", false, "update the test files with the current generated content") | ||
|
|
||
| func TestCompatibleComponentsSectionUpdated(t *testing.T) { |
There was a problem hiding this comment.
If someone forgets to update the docs, CI will fail. But updating them is also as easy as running go generate for this file.
| @@ -41,6 +41,38 @@ Name | Type | Description | |||
|
|
|||
| `loki.echo` does not expose any component-specific debug information. | |||
|
|
|||
| <!-- START GENERATED COMPATIBLE COMPONENTS --> | |||
There was a problem hiding this comment.
Here just for fun I put the section in a different place rather than at the end. The auto-updating will add the section at the end if it doesn't exist, but it can be moved around and tests will still detect it and update it in its existing location.
|
This PR has been automatically marked as stale because it has not had any activity in the past 30 days. The PR will not be closed automatically, but a label will be added to it for tracking purposes. |
marctc
added
needs-attention
thampiotr
force-pushed
the
thampiotr/prototype-component-x-links
branch
from
7cbf2ab
to
51bfdae
Compare
|
cc @thampiotr closing this after we've moved ahead with #5791. Let me know if you think otherwise and we can open it again. |
github-actions
bot
added
the
frozen-due-to-age
PR Description
This is a prototype for the proposal #4754
Please see the proposal for detailed information.
Which issue(s) this PR fixes
PR Checklist