Integration assistant generate readme #192887
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
haetamoudi
added
enhancement
4 tasks
|
Pinging @elastic/security-scalability (Team:Security-Scalability) |
haetamoudi
added
backport:prev-major
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: cc @haetamoudi |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Sep 17, 2024
## Summary - Create an integration `README` when using the Integration Assistant so that it is displayed when opening the newly created integration. - Increase code coverage for the Integration Assistant plugin. (cherry picked from commit e360963)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Sep 17, 2024
## Summary - Create an integration `README` when using the Integration Assistant so that it is displayed when opening the newly created integration. - Increase code coverage for the Integration Assistant plugin. (cherry picked from commit e360963)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Sep 17, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [Integration assistant generate readme (#192887)](#192887) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Hanna Tamoudi","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-17T16:31:18Z","message":"Integration assistant generate readme (#192887)\n\n## Summary\r\n\r\n- Create an integration `README` when using the Integration Assistant so\r\nthat it is displayed when opening the newly created integration.\r\n- Increase code coverage for the Integration Assistant plugin.","sha":"e360963065ab783c9cf265869fb43b2f73f74368","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["enhancement","release_note:skip","v9.0.0","backport:prev-major","v8.16.0","Team:Security-Scalability","v8.15.2","Feature:AutomaticImport"],"title":"Integration assistant generate readme","number":192887,"url":"https://github.com/elastic/kibana/pull/192887","mergeCommit":{"message":"Integration assistant generate readme (#192887)\n\n## Summary\r\n\r\n- Create an integration `README` when using the Integration Assistant so\r\nthat it is displayed when opening the newly created integration.\r\n- Increase code coverage for the Integration Assistant plugin.","sha":"e360963065ab783c9cf265869fb43b2f73f74368"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.15"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192887","number":192887,"mergeCommit":{"message":"Integration assistant generate readme (#192887)\n\n## Summary\r\n\r\n- Create an integration `README` when using the Integration Assistant so\r\nthat it is displayed when opening the newly created integration.\r\n- Increase code coverage for the Integration Assistant plugin.","sha":"e360963065ab783c9cf265869fb43b2f73f74368"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Hanna Tamoudi <[email protected]>
kibanamachine
added a commit
that referenced
this pull request
Sep 17, 2024
# Backport This will backport the following commits from `main` to `8.15`: - [Integration assistant generate readme (#192887)](#192887) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Hanna Tamoudi","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-17T16:31:18Z","message":"Integration assistant generate readme (#192887)\n\n## Summary\r\n\r\n- Create an integration `README` when using the Integration Assistant so\r\nthat it is displayed when opening the newly created integration.\r\n- Increase code coverage for the Integration Assistant plugin.","sha":"e360963065ab783c9cf265869fb43b2f73f74368","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["enhancement","release_note:skip","v9.0.0","backport:prev-major","v8.16.0","Team:Security-Scalability","v8.15.2","Feature:AutomaticImport"],"title":"Integration assistant generate readme","number":192887,"url":"https://github.com/elastic/kibana/pull/192887","mergeCommit":{"message":"Integration assistant generate readme (#192887)\n\n## Summary\r\n\r\n- Create an integration `README` when using the Integration Assistant so\r\nthat it is displayed when opening the newly created integration.\r\n- Increase code coverage for the Integration Assistant plugin.","sha":"e360963065ab783c9cf265869fb43b2f73f74368"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.15"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192887","number":192887,"mergeCommit":{"message":"Integration assistant generate readme (#192887)\n\n## Summary\r\n\r\n- Create an integration `README` when using the Integration Assistant so\r\nthat it is displayed when opening the newly created integration.\r\n- Increase code coverage for the Integration Assistant plugin.","sha":"e360963065ab783c9cf265869fb43b2f73f74368"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Hanna Tamoudi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
READMEwhen using the Integration Assistant so that it is displayed when opening the newly created integration.Context
Related issue: #192704
Result
READMEis now automatically created.READMEis identical to the one found in_dev/build/docs. A follow-up PR will enhance the content of theREADMEbased on the requirements outlined in issue #192704.Code coverage of the integration assistant plugin is improved.
Checklist
Delete any items that are not applicable to this PR.