Skip to content

[Automatic Import] add fields mapping to readme#193717

Merged
haetamoudi merged 12 commits intoelastic:mainfrom
haetamoudi:automatic-import-readme-with-fields-mapping
Sep 30, 2024
Merged

[Automatic Import] add fields mapping to readme#193717
haetamoudi merged 12 commits intoelastic:mainfrom
haetamoudi:automatic-import-readme-with-fields-mapping

Conversation

@haetamoudi
Copy link
Contributor

@haetamoudi haetamoudi commented Sep 23, 2024 •
edited by kibanamachine
Loading

Summary

Duplicate of #193334

Automatic import flow creates 2 Readme files:

  • Content of docs/README.md will contain the mapping fields for each datastream and will be used to show information when opening a newly created integration.
  • Content of _dev/build/docs/README.md will contain a placeholder that can be replaced when using elastic-package.

Test results:

Use Automatic import to create a new integration.

docs/README.md
Screenshot 2024-09-18 at 18 09 51
That will be displayed like:
Screenshot 2024-09-18 at 18 08 16

_dev/build/docs/README.md
Screenshot 2024-09-18 at 18 10 21
@haetamoudi haetamoudi self-assigned this Sep 23, 2024
@haetamoudi haetamoudi added enhancement New value added to drive a business result release_note:skip Skip the PR/issue when compiling release notes backport:prev-major Team:Security-Scalability Security Integrations Scalability Team Feature:AutomaticImport labels Sep 23, 2024
@haetamoudi haetamoudi marked this pull request as ready for review September 23, 2024 13:29
@haetamoudi haetamoudi requested a review from a team as a code owner September 23, 2024 13:29
@elasticmachine
Copy link
Contributor

elasticmachine commented Sep 23, 2024

Pinging @elastic/security-scalability (Team:Security-Scalability)
@haetamoudi haetamoudi marked this pull request as draft September 23, 2024 14:06
@haetamoudi haetamoudi marked this pull request as ready for review September 23, 2024 16:25
ilyannn
ilyannn reviewed Sep 24, 2024
View reviewed changes
ilyannn
ilyannn reviewed Sep 24, 2024
View reviewed changes
@haetamoudi haetamoudi requested a review from ilyannn September 24, 2024 17:21
@ilyannn
Copy link
Contributor

ilyannn commented Sep 25, 2024

Good work, but I think we should strive to make the two readmes have the same relationship as if the user actually ran the elastic-package build. There are currently some differences, which I've checked by downloading a generated package and running

git init
git add .
git commit -m "Generated version"
elastic-package build
git diff > diff.txt

Here's an example diff.txt. I think the differences are mostly in the whitespace, default value and the additional files, such as base-fields.yml.

If it's not too hard to replicate what the elastic-package does, let's try to kill this diff.
ilyannn
ilyannn requested changes Sep 25, 2024
View reviewed changes
Copy link
Contributor

@ilyannn ilyannn left a 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.
@haetamoudi haetamoudi requested a review from ilyannn September 27, 2024 14:38
ilyannn
ilyannn approved these changes Sep 30, 2024
View reviewed changes
Copy link
Contributor

@ilyannn ilyannn left a 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?)
@kibana-ci
Copy link

kibana-ci commented Sep 30, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #1 / Cloud Security Posture Test adding Cloud Security Posture Integrations CNVM CNVM AWS Hyperlink on PostInstallation Modal should have the correct URL

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @haetamoudi
@haetamoudi haetamoudi added backport:skip This PR does not require backporting and removed backport:prev-major labels Sep 30, 2024
@haetamoudi haetamoudi merged commit 5081414 into elastic:main Sep 30, 2024
@haetamoudi haetamoudi deleted the automatic-import-readme-with-fields-mapping branch September 30, 2024 15:46
@bhapas bhapas added backport:prev-minor and removed backport:skip This PR does not require backporting labels Oct 10, 2024
@kibanamachine
Copy link
Contributor

kibanamachine commented Oct 10, 2024

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11272440817
@kibanamachine
Copy link
Contributor

kibanamachine commented Oct 10, 2024

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11272440702
@kibanamachine
Copy link
Contributor

kibanamachine commented Oct 10, 2024

💔 All backports failed

Status Branch Result
❌ 8.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 193717

Questions ?

Please refer to the Backport tool documentation
1 similar comment
@kibanamachine
Copy link
Contributor

kibanamachine commented Oct 10, 2024

💔 All backports failed

Status Branch Result
❌ 8.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 193717

Questions ?

Please refer to the Backport tool documentation
bhapas pushed a commit to bhapas/kibana that referenced this pull request Oct 10, 2024
@haetamoudi
[Automatic Import] add fields mapping to readme (elastic#193717)
1fb9e86 
(cherry picked from commit 5081414)

# Conflicts:
#	x-pack/plugins/integration_assistant/server/integration_builder/build_integration.test.ts
@bhapas bhapas mentioned this pull request Oct 10, 2024
Merged
@bhapas
Copy link
Contributor

bhapas commented Oct 10, 2024

💚 All backports created successfully

Status Branch Result
✅ 8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation
bhapas added a commit that referenced this pull request Oct 10, 2024
@bhapas @haetamoudi
[8.x] [Automatic Import] add fields mapping to readme (#193717) (#195747
09889d9 
)

# 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":"hanna.tamoudi@elastic.co"},"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 <hanna.tamoudi@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New value added to drive a business result Feature:AutomaticImport release_note:skip Skip the PR/issue when compiling release notes Team:Security-Scalability Security Integrations Scalability Team v8.16.0 v9.0.0

6 participants

@haetamoudi @elasticmachine @ilyannn @kibana-ci @kibanamachine @bhapas