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
Make collectors/COLLECTORS.md have its list autogenerated from integrations.js #15995
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Workflow looks good. Left some suggestions for the Python code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add it to the integration workflow. I find it weird to merge 2 PRs instead of 1 when they are totally related.
Well, they are not entirely related, one generates the file and the other is one piece that utilizes the js file. Like one is making something that is used by everyone, while the other is responsible for generating documentation out of it 🤔 |
I would tend to agree with Ilya on having it be one PR instead of more than one. We can simply add a step to the existing workflow to run this script after the new integrations.js file is generated. |
wait what 1st always triggers 2nd, I think those changes should be in one PR. |
Thanks for the feedback, I added the steps from the action file I had made to the existing action for integrations |
found a small bug, gonna push a new commit to fix and re-request approvals, parentheses in the links should not be there, but simple fix |
Summary
This script reads the integrations/integrations.js file and generates the list of data collection integrations inside collectors/COLLECTORS.md, with proper links that Learn can replace into Learn links.
Due to the string replacements the script does, I have ran it once in this PR, to change the top header (that it looks to split every time) to the desired one.
@Ferroin please check the script and the action addition
@sashwathn please check the outcome in the markdown file