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.

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

[8.15] [Automatic Import] Safely output the package manifest (#192316) #192524

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

kibanamachine
Copy link
Contributor

Backport

This will backport the following commits from main to 8.15:

Questions ?

Please refer to the Backport tool documentation

## Release note

Fixes issues with rendering the package manifest in Automatic Import.

## Summary

Previously the multiline output or special symbols in the user-provided
strings, like description, were breaking YAML structure of the package
manifest. The user would be confronted with a message like this, during
the last step, after all the work of generating the integration was
completed.

The incorrect behavior can be observed in detail with a failing test in
the first commit of the PR.

In this PR, we change the manifest construction logic from template
rendering into TypeScript code. As a result, all user-provided strings
are correctly serialized. We keep as close as possible to the original
manifest structure, also keeping the parameter names.

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
(cherry picked from commit 521b6ee)
@bhapas bhapas self-assigned this Sep 10, 2024
@bhapas bhapas added bug Fixes for quality problems that affect the customer experience release_note:fix Team:Security-Scalability Team label for Security Integrations Scalability Team labels Sep 10, 2024
@elasticmachine
Copy link
Contributor

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

@kibanamachine kibanamachine merged commit 8457287 into elastic:8.15 Sep 10, 2024
27 checks passed
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Unknown metric groups

ESLint disabled in files

id before after diff
integrationAssistant 4 5 +1

Total ESLint disabled count

id before after diff
integrationAssistant 11 12 +1

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

cc @ilyannn @bhapas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport bug Fixes for quality problems that affect the customer experience release_note:fix Team:Security-Scalability Team label for Security Integrations Scalability Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants