Skip to content

Use "elastic-package build" to render README.md files.#410

Merged
mtojek merged 5 commits intoelastic:masterfrom
mtojek:151-use-ep-build
Nov 23, 2020
Merged

Use "elastic-package build" to render README.md files.#410
mtojek merged 5 commits intoelastic:masterfrom
mtojek:151-use-ep-build

Conversation

@mtojek
Copy link
Copy Markdown
Contributor

@mtojek mtojek commented Nov 20, 2020

What does this PR do?

This PR adjusts the Integrations repository to latest changes introduced to elastic-package.

Changes:

  1. The elastic-package will be responsible for rendering README.md files.
  2. README.md template files will be part of packages (in the _dev/build/docs directory).
  3. Sample events in README files will be formatted.
  4. The dryRunPackageRegistry has been removed as it's covered with package validation (no need to run it twice).

How to test this PR locally

CI will verify the Magefile changes.

Related issues

@mtojek mtojek self-assigned this Nov 20, 2020
@elasticmachine
Copy link
Copy Markdown

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #410 opened]

  • Start Time: 2020-11-20T13:03:45.991+0000

  • Duration: 9 min 27 sec

Test stats 🧪

Test Results
Failed 0
Passed 10
Skipped 0
Total 10

@mtojek mtojek marked this pull request as ready for review November 20, 2020 13:22
@mtojek mtojek requested a review from ycombinator November 20, 2020 13:22
@mtojek mtojek added the Team:Integrations Label for the Integrations team label Nov 20, 2020
@elasticmachine
Copy link
Copy Markdown

Pinging @elastic/integrations (Team:Integrations)

@mtojek
Copy link
Copy Markdown
Contributor Author

mtojek commented Nov 20, 2020

Most likely I'll have to rebase against the master branch to pull latest changes.

Copy link
Copy Markdown
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a nitpick but LGTM.

Nice to see more code being removed from the integrations repo in favor of elastic-package usage!

Co-authored-by: Shaunak Kashyap <ycombinator@gmail.com>
@mtojek mtojek merged commit 242c692 into elastic:master Nov 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team:Integrations Label for the Integrations team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use "build" command to build README files

3 participants