Skip to content

Update clients docs to use 8.19 branch #3216

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 5 commits into from
Apr 30, 2025
Merged

Update clients docs to use 8.19 branch #3216

merged 5 commits into from
Apr 30, 2025

Conversation

leemthompo
Copy link
Contributor

Attempts to fix broken build

@pquentin pointed to this list of repos that renamed 8.x to 8.19: https://github.com/elastic/devtools-team/blob/main/.github/workflows/scripts/clients.config

@leemthompo leemthompo self-assigned this Apr 30, 2025
@leemthompo leemthompo requested a review from a team as a code owner April 30, 2025 09:27
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

szabosteve
szabosteve previously approved these changes Apr 30, 2025
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

@leemthompo
Copy link
Contributor Author

leemthompo commented Apr 30, 2025

@pquentin I think we need to update at least some of the java client entries, but tbh I'm not super sure about all of them:

docs/conf.yaml

Lines 1057 to 1082 in 5cb7ead

- title: Java Client
prefix: java-api-client
current: *stackcurrent
branches: [ 8.x, 8.18, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ]
live: *stacklive
index: docs/index.asciidoc
chunk: 1
tags: Clients/Java
subject: Clients
sources:
-
repo: elasticsearch-java
path: docs/
-
repo: elasticsearch-java
path: java-client/src/test/java/co/elastic/clients/documentation
-
repo: elasticsearch
path: docs/java-rest/
map_branches:
8.x: 8.19
-
repo: elasticsearch
path: client
map_branches:
8.x: 8.19

@pquentin
Copy link
Member

@leemthompo Not sure either, I don't think we care anymore about elasticsearch/client or elasticsearch/docs/java-rest. @swallez @l-trotta any idea?

@leemthompo
Copy link
Contributor Author

The build error FYI:

INFO:build_docs:Error executing: git archive --format=tar -o /tmp/docsbuild/Z4QZ2pb99E/elasticsearch-java/.temp_git_archive.tar 8.x docs in GIT_DIR /docs_build/.repos/elasticsearch-java.git
INFO:build_docs:fatal: Not a valid object name

Copy link
Contributor

@colleenmcginnis colleenmcginnis Apr 30, 2025

Choose a reason for hiding this comment

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

It looks like both the Python and Rust clients need to be updated in this file. The Perl client is still using 8.x and the rest seem to have never made it to v8.

Edit: A quick way to check is to just go to https://github.com/elastic/{repo}/tree/8.x and see if it redirects to 8.19 (for example https://github.com/elastic/elasticsearch-rs/tree/8.x).

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

The build is lookin' good so far!

@leemthompo leemthompo enabled auto-merge (squash) April 30, 2025 13:03
@leemthompo leemthompo merged commit 81dde85 into master Apr 30, 2025
3 checks passed
@leemthompo leemthompo deleted the leemthompo/8X2819 branch April 30, 2025 13:35
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