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.

Sign up for GitHub

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

Jump to bottom

[Automatic Import] Use provided data stream description in generated README #201294

Closed
ebeahan opened this issue Nov 21, 2024 · 1 comment · Fixed by #203236
Closed

[Automatic Import] Use provided data stream description in generated README #201294

ebeahan opened this issue Nov 21, 2024 · 1 comment · Fixed by #203236
Assignees
@bhapas
Labels
enhancement New value added to drive a business result Feature:AutomaticImport Team:Security-Scalability Team label for Security Integrations Scalability Team

Comments

@ebeahan
Copy link
Member

ebeahan commented Nov 21, 2024

Describe the feature: Auto Import adds the user-provided data stream description into the data stream manifest.yml file. The description could also populate details into the generated REAMDE.md file.

Describe a specific use case for the feature: Include the data stream description's text when generating the data stream section of the README file: https://github.com/elastic/kibana/blob/main/x-pack/plugins/integration_assistant/server/templates/build_readme.md.njk
@ebeahan ebeahan added enhancement New value added to drive a business result Feature:AutomaticImport Team:Security-Scalability Team label for Security Integrations Scalability Team labels Nov 21, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-scalability (Team:Security-Scalability)

@bhapas bhapas self-assigned this Dec 5, 2024
@bhapas bhapas mentioned this issue Dec 6, 2024
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Dec 10, 2024
@bhapas
[Automatic Import] Use datastream description in readme (elastic#203236)
b0e6c40 
## Release note

Use provided data stream description in generated README

## Summary

Closes [elastic#201294](elastic#201294)

This PR fixes use of `datastream description` that the user entered in
the input field.

![image](https://github.com/user-attachments/assets/b093c978-2102-4bdc-824e-d60aa3fd908b)

(cherry picked from commit d3161ab)
pull bot pushed a commit to miqdigital/kibana that referenced this issue Dec 10, 2024
@bhapas
[Automatic Import] Use datastream description in readme (elastic#203236)
d3161ab 
## Release note

Use provided data stream description in generated README

## Summary

Closes [elastic#201294](elastic#201294)

This PR fixes use of `datastream description` that the user entered in
the input field.


![image](https://github.com/user-attachments/assets/b093c978-2102-4bdc-824e-d60aa3fd908b)
kibanamachine added a commit that referenced this issue Dec 10, 2024
@kibanamachine @bhapas
[8.x] [Automatic Import] Use datastream description in readme (#203236)…
93cda05 
… (#203516)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Automatic Import] Use datastream description in readme
(#203236)](#203236)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Bharat
Pasupula","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-10T06:32:22Z","message":"[Automatic
Import] Use datastream description in readme (#203236)\n\n## Release
note\r\n\r\nUse provided data stream description in generated
README\r\n\r\n## Summary\r\n\r\nCloses
[#201294](https://github.com/elastic/kibana/issues/201294)\r\n\r\nThis
PR fixes use of `datastream description` that the user entered in\r\nthe
input
field.\r\n\r\n\r\n![image](https://github.com/user-attachments/assets/b093c978-2102-4bdc-824e-d60aa3fd908b)","sha":"d3161abc38f47284e5aaa41590ef89f8b78f28f3","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","v9.0.0","backport:prev-minor","Team:Security-Scalability","backport:version","Feature:AutomaticImport"],"title":"[Automatic
Import] Use datastream description in
readme","number":203236,"url":"https://github.com/elastic/kibana/pull/203236","mergeCommit":{"message":"[Automatic
Import] Use datastream description in readme (#203236)\n\n## Release
note\r\n\r\nUse provided data stream description in generated
README\r\n\r\n## Summary\r\n\r\nCloses
[#201294](https://github.com/elastic/kibana/issues/201294)\r\n\r\nThis
PR fixes use of `datastream description` that the user entered in\r\nthe
input
field.\r\n\r\n\r\n![image](https://github.com/user-attachments/assets/b093c978-2102-4bdc-824e-d60aa3fd908b)","sha":"d3161abc38f47284e5aaa41590ef89f8b78f28f3"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/203236","number":203236,"mergeCommit":{"message":"[Automatic
Import] Use datastream description in readme (#203236)\n\n## Release
note\r\n\r\nUse provided data stream description in generated
README\r\n\r\n## Summary\r\n\r\nCloses
[#201294](https://github.com/elastic/kibana/issues/201294)\r\n\r\nThis
PR fixes use of `datastream description` that the user entered in\r\nthe
input
field.\r\n\r\n\r\n![image](https://github.com/user-attachments/assets/b093c978-2102-4bdc-824e-d60aa3fd908b)","sha":"d3161abc38f47284e5aaa41590ef89f8b78f28f3"}}]}]
BACKPORT-->

Co-authored-by: Bharat Pasupula <[email protected]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 12, 2024
@bhapas @CAWilson94
[Automatic Import] Use datastream description in readme (elastic#203236)
f530e85 
## Release note

Use provided data stream description in generated README

## Summary

Closes [elastic#201294](elastic#201294)

This PR fixes use of `datastream description` that the user entered in
the input field.


![image](https://github.com/user-attachments/assets/b093c978-2102-4bdc-824e-d60aa3fd908b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bhapas bhapas

Labels
enhancement New value added to drive a business result Feature:AutomaticImport Team:Security-Scalability Team label for Security Integrations Scalability Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Automatic Import] Use datastream description in readme bhapas/kibana
3 participants
@ebeahan @elasticmachine @bhapas