-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Automatic Import] add fields mapping to readme #193717
[Automatic Import] add fields mapping to readme #193717
Conversation
Pinging @elastic/security-scalability (Team:Security-Scalability) |
x-pack/plugins/integration_assistant/server/integration_builder/fields.ts
Show resolved
Hide resolved
Good work, but I think we should strive to make the two readmes have the same relationship as if the user actually ran the
Here's an example diff.txt. I think the differences are mostly in the whitespace, default value and the additional files, such as If it's not too hard to replicate what the |
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 had some points to address.
The goal to replicate elastic-package
isn't absolute, so let's skip it if it proves too hard.
x-pack/plugins/integration_assistant/server/templates/package_readme.md.njk
Outdated
Show resolved
Hide resolved
x-pack/plugins/integration_assistant/server/integration_builder/fields.ts
Outdated
Show resolved
Hide resolved
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.
Looks good, though I have not tested it yet.
We might want to think about the actual content of the README (generate with LLM?)
x-pack/plugins/integration_assistant/server/integration_builder/fields.test.ts
Outdated
Show resolved
Hide resolved
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @haetamoudi |
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11272440817 |
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11272440702 |
💔 All backports failed
Manual backportTo create the backport manually run:
Questions ?Please refer to the Backport tool documentation |
1 similar comment
💔 All backports failed
Manual backportTo create the backport manually run:
Questions ?Please refer to the Backport tool documentation |
(cherry picked from commit 5081414) # Conflicts: # x-pack/plugins/integration_assistant/server/integration_builder/build_integration.test.ts
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
) # Backport This will backport the following commits from `main` to `8.x`: - [[Automatic Import] add fields mapping to readme (#193717)](#193717) <!--- Backport version: 8.9.8 --> ### 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-30T15:46:05Z","message":"[Automatic Import] add fields mapping to readme (#193717)","sha":"508141423e7d18ce87628d826628d161c3292418","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-minor","Team:Security-Scalability","Feature:AutomaticImport"],"number":193717,"url":"https://github.com/elastic/kibana/pull/193717","mergeCommit":{"message":"[Automatic Import] add fields mapping to readme (#193717)","sha":"508141423e7d18ce87628d826628d161c3292418"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193717","number":193717,"mergeCommit":{"message":"[Automatic Import] add fields mapping to readme (#193717)","sha":"508141423e7d18ce87628d826628d161c3292418"}}]}] BACKPORT--> --------- Co-authored-by: Hanna Tamoudi <[email protected]>
Summary
Duplicate of #193334
Automatic import flow creates 2
Readme
files:docs/README.md
will contain the mapping fields for each datastream and will be used to show information when opening a newly created integration._dev/build/docs/README.md
will contain a placeholder that can be replaced when usingelastic-package
.Test results:
Use Automatic import to create a new integration.
docs/README.md
That will be displayed like:
_dev/build/docs/README.md