[Fleet] Add Edit ReadMe Functionality To Custom Integrations#215259
Merged
Supplementing merged 45 commits intoelastic:mainfrom Apr 23, 2025
Merged
[Fleet] Add Edit ReadMe Functionality To Custom Integrations#215259Supplementing merged 45 commits intoelastic:mainfrom
Supplementing merged 45 commits intoelastic:mainfrom
Conversation
nchaulet
reviewed
Apr 14, 2025
x-pack/platform/plugins/shared/fleet/common/types/rest_spec/custom_integrations.ts
Show resolved
Hide resolved
…nstead of array, made button conditionally render, other small changes
…ent the versioning
Contributor
Author
|
/CI |
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/dashboards --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --update'
…ting/kibana into enhancment-edit-readme
…ng for non-custom integrations
Contributor
|
Pinging @elastic/fleet (Team:Fleet) |
Contributor
Author
|
@elasticmachine merge upstream |
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/dashboards --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/alerting/maintenance_window --update'
...applications/integrations/sections/epm/screens/detail/components/edit_integration_flyout.tsx
Outdated
Show resolved
Hide resolved
.../plugins/shared/fleet/public/applications/integrations/sections/epm/screens/detail/index.tsx
Outdated
Show resolved
Hide resolved
.../plugins/shared/fleet/public/applications/integrations/sections/epm/screens/detail/index.tsx
Outdated
Show resolved
Hide resolved
.../plugins/shared/fleet/public/applications/integrations/sections/epm/screens/detail/index.tsx
Outdated
Show resolved
Hide resolved
…ting/kibana into enhancment-edit-readme
Contributor
Author
|
@elasticmachine merge upstream |
nchaulet
reviewed
Apr 23, 2025
| // update the changelog asset as well by adding an entry | ||
| const changelogPath = `${pkgName}-${data.version}/changelog.yml`; | ||
| const changelog = assetsMap.get(changelogPath); | ||
| if (changelog) { |
Member
Member
There was a problem hiding this comment.
Actually looks like the error was related to that change #217257 I will comment there
nchaulet
reviewed
Apr 23, 2025
x-pack/platform/plugins/shared/fleet/common/types/rest_spec/custom_integrations.ts
Outdated
Show resolved
Hide resolved
juliaElastic
approved these changes
Apr 23, 2025
…n in FE and test cases
Contributor
Author
|
@elasticmachine merge upstream |
nchaulet
approved these changes
Apr 23, 2025
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/dashboards --include-path /api/saved_objects/_import --include-path /api/saved_objects/_export --include-path /api/alerting/maintenance_window --update'
Contributor
💚 Build Succeeded
Metrics [docs]Module Count
Public APIs missing comments
Async chunks
Page load bundle
History
|
7 tasks
Supplementing
added a commit
that referenced
this pull request
Apr 25, 2025
## Summary Closes elastic/ingest-dev#5219 - Adds support for editing and saving the categories of a custom integration. Enhancement of #215259 https://github.com/user-attachments/assets/dca360e6-936a-44aa-b80e-cb4626f7aed2 ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks N/A --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
akowalska622
pushed a commit
to akowalska622/kibana
that referenced
this pull request
May 29, 2025
…#215259) Closes elastic#212957 Adds editing of the automatically-generated readMe file on custom integrations. - Allows the user to make edits and then save the readMe changes via a new endpoint - Reloads the UI after making changes to reflect the updated readMe - Automatically updates associated policies To test the new endpoint, you will need a custom integration installed, then use it as such ``` PUT kbn:/api/fleet/epm/custom_integrations/{pkgName} { "readMeData": "New README content here" } ``` https://github.com/user-attachments/assets/9a6f2197-aa7f-4610-9476-c1f8b4865c62 ### Acceptance criteria - [ ] An "edit" button with an icon appears in the README section of the integration overview page for custom integrations generated by automatic import - [ ] Clicking the "edit" button should open a modal (TBD) containing a markdown editor that allows the user to edit the content - [ ] Users can save their changes, and the updated README content is persisted - [ ] Saving updates the version of the package and reloads the content - [ ] Saving also starts updating policies automatically ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks N/A # Release Note Adds edit functionality to custom integrations, allowing a user to edit the README file of a custom integration and save it to be persisted. Additionally, saving will automatically increment the version of the integration and update all associated policies. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
akowalska622
pushed a commit
to akowalska622/kibana
that referenced
this pull request
May 29, 2025
## Summary Closes elastic/ingest-dev#5219 - Adds support for editing and saving the categories of a custom integration. Enhancement of elastic#215259 https://github.com/user-attachments/assets/dca360e6-936a-44aa-b80e-cb4626f7aed2 ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks N/A --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This file contains hidden or 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
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.

Closes #212957
Adds editing of the automatically-generated readMe file on custom integrations.
To test the new endpoint, you will need a custom integration installed, then use it as such
Screen.Recording.2025-04-16.at.12.35.32.PM.mov
Acceptance criteria
Checklist
Check the PR satisfies following conditions.
Reviewers should verify this PR satisfies this list as well.
release_note:breakinglabel should be applied in these situations.release_note:*label is applied per the guidelinesIdentify risks
N/A
Release Note
Adds edit functionality to custom integrations, allowing a user to edit the README file of a custom integration and save it to be persisted. Additionally, saving will automatically increment the version of the integration and update all associated policies.