Skip to content

Add elasticsearch-java doc code snippets directory #2308

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

Merged
merged 1 commit into from
Dec 7, 2021

Conversation

swallez
Copy link
Member

@swallez swallez commented Dec 6, 2021

elastic/elasticsearch-java#52 pulls code snippets in the document from test source code, which is not checked out by the docs build process.

This PR adds the path to that test source code in the elasticsearch-java (java-api-client) configuration.

@szabosteve szabosteve requested a review from gtback December 7, 2021 08:41
@szabosteve
Copy link
Contributor

@gtback Could you please have a look at this PR? If I understand correctly, it fails because the referenced folder is empty. This PR, however, fails on the docs test because the test files are not found as their path is not referenced in the conf.yml.
In my understanding, the solution would be to add the test files to the path in the java repo in a separate PR, then merge this PR in the docs repository, finally reference the test files in the code snippets of the asciidoc files in the java repo. Am I reading the situation right?
CC @swallez

@szabosteve
Copy link
Contributor

@elasticmachine test this please

@swallez
Copy link
Member Author

swallez commented Dec 7, 2021

@elasticmachine test this please

(added missing files to the 8.0 branch in addition to main and 7.16)

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

@swallez swallez merged commit 9509ecb into elastic:master Dec 7, 2021
@gtback
Copy link
Member

gtback commented Dec 7, 2021

@szabosteve Yes, there are some times when neither PR will pass without the other, so you'll need to just merge one without CI passing and then the other one should pass. It looks like it got figured out in this case.

(added missing files to the 8.0 branch in addition to main and 7.16)

You can also use exclude_branches to say "don't use these files/paths when building this list of versions" (so in this case exclude_branches: [ 8.0 ])

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.

3 participants