Skip to content

Conversation

@mrodm
Copy link
Contributor

@mrodm mrodm commented Jul 10, 2023

This PR adds a new section in the README to include the information about the test integrations automation.

This PR also merges the two Development sections that were available in the README.

Rendered README can be checked here.

Follow-up #1277

Elasticsearch in stacks managed by elastic-package. It is recommended to use
an absolute path, out of the `.elastic-package` directory.

## Development
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This section was duplicated. Merged into the other Development section in line 39

Comment on lines +44 to +58
`make build` - build the tool source

`make clean` - delete elastic-package binary and build folder

`make format` - format the Go code

`make check` - one-liner, used by CI to verify if source code is ready to be pushed to the repository

`make install` - build the tool source and move binary to `$GOBIN`

`make gomod` - ensure go.mod and go.sum are up to date

`make update` - update README.md file

`make licenser` - add the Elastic license header in the source code
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a few more targets, and change make vendor target by the make gomod one.

@mrodm mrodm marked this pull request as ready for review July 11, 2023 15:05
@mrodm mrodm requested a review from a team July 11, 2023 15:06
@mrodm mrodm self-assigned this Jul 11, 2023
@mrodm
Copy link
Contributor Author

mrodm commented Jul 11, 2023

/test

@mrodm mrodm requested a review from jsoriano July 12, 2023 13:46
Comment on lines 106 to 108
This process can also be done automatically directly from your Pull Request by adding a comment `test integrations`. Example:
- Comment: https://github.com/elastic/elastic-package/pull/1335#issuecomment-1619721861
- Pull Request created in integrations repository: https://github.com/elastic/integrations/pull/6756
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should mention this first, before the detailed steps.

@mrodm mrodm requested a review from jsoriano July 13, 2023 08:22
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @mrodm

Copy link
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

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

👍

@mrodm mrodm merged commit 6d1d182 into elastic:main Jul 13, 2023
@mrodm mrodm deleted the update_readme_test_integrations branch July 13, 2023 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants