Skip to content

Update branches for 2.13.0 release #2316

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
Jan 12, 2022

Conversation

obierlaire
Copy link
Contributor

@obierlaire obierlaire commented Dec 13, 2021

Updates the branches for: ECE, ecctl for the
upcoming ECE 2.13.0 release.

Copy link
Member

@gtback gtback left a comment

Choose a reason for hiding this comment

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

LGTM!

The build error relates to a missing file:

09:31:39 INFO:build_docs:asciidoctor: ERROR: index.asciidoc: line 8: include file not found: /tmp/docsbuild/Q0aeS3yX89/cloud/docs/ece-version.asciidoc

Am I right thinking that this file gets generated dynamically as part of the ECE release? We'll have to find some way to make it available for docs builds.

@kellyemurphy
Copy link
Contributor

Am I right thinking that this file gets generated dynamically as part of the ECE release?

IIRC, that's the case. The Cloud writers have been creating an empty file, that isn't saved, so that we can get the builds to pass.

@kellyemurphy
Copy link
Contributor

@obierlaire confirmed that this error is expected and we can just merge/get someone to help us merge when it's time.

@gtback
Copy link
Member

gtback commented Jan 10, 2022

@obierlaire confirmed that this error is expected and we can just merge/get someone to help us merge when it's time.

@obierlaire @kellyemurphy are you saying that the file will be committed to the cloud repo as part of the release? We don't run any of the cloud build steps as part of the docs build, so unless the file already exists when the doc build starts, it will fail after this is merged.

@nrichers
Copy link

nrichers commented Jan 10, 2022

@obierlaire @kellyemurphy are you saying that the file will be committed to the cloud repo as part of the release? We don't run any of the cloud build steps as part of the docs build, so unless the file already exists when the doc build starts, it will fail after this is merged.

@gtback I believe @alpar-t introduced a change to the ECE docs that uses a generated ece-version.asciidoc file. This change breaks our docbldece doc build alias without the workaround described by @kellyemurphy and by the looks of it can also break the CI checks in the elastic/docs repo.

Alpár, you had added this ece-version.asciidoc file to the .gitignore, but is there a way we can modify your implementation to avoid these build breaks?

@alpar-t
Copy link
Contributor

alpar-t commented Jan 11, 2022

@nrichers The purpose of the change was to make it so we keep a single record of truth about the version across the repo. We do have a pattern where we do commit other generated files into the repo and check that they match what we expect, but I'm not sure it's warranted in this case. Could we just run the one Gradle target ./gradlew generateVersionFile as part of the affected builds to generate the version file ?

@nrichers
Copy link

nrichers commented Jan 11, 2022

@alpar-t let's move the discussion for how to best address this into the related issue in the cloud repo?

For now, I will force merge this PR as we need to get the 2.13 release out.

EDIT: I don't have admin privileges on this repo ... @gtback can you help?

EDIT EDIT: We ended up creating a workaround in the cloud repo to get the Elastic docs build to pass. The CI checks in this case are likely right, so we don't want to force merge the PR after all.

@gtback
Copy link
Member

gtback commented Jan 11, 2022

@elasticmachine run elasticsearch-ci/docs

@nrichers
Copy link

@elasticmachine run elasticsearch-ci/docs

@nrichers
Copy link

nrichers commented Jan 11, 2022

Good news, bad news scenario: on the upside, the ECE 2.13 docs build works, thanks to the workaround mentioned above. On the downside, we now have a bunch of broken links:

15:21:30 INFO:build_docs:Bad cross-document links:
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-enterprise/2.13/ece-cloud-ingest-data.html contains broken links to:
15:21:30 INFO:build_docs:   - en/fleet/7.16/elastic-agent-installation-configuration.html
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-enterprise/2.13/ece-enable-ccs.html contains broken links to:
15:21:30 INFO:build_docs:   - en/elasticsearch/reference/7.16/modules-remote-clusters.html#gateway-nodes-selection
15:21:30 INFO:build_docs:   - en/elasticsearch/reference/7.16/modules-remote-clusters.html#proxy-mode
15:21:30 INFO:build_docs:   - en/elasticsearch/reference/7.16/modules-remote-clusters.html#sniff-mode
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-enterprise/current/ece-cloud-ingest-data.html contains broken links to:
15:21:30 INFO:build_docs:   - en/fleet/7.16/elastic-agent-installation-configuration.html
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/cloud-enterprise/current/ece-enable-ccs.html contains broken links to:
15:21:30 INFO:build_docs:   - en/elasticsearch/reference/7.16/modules-remote-clusters.html#gateway-nodes-selection
15:21:30 INFO:build_docs:   - en/elasticsearch/reference/7.16/modules-remote-clusters.html#proxy-mode
15:21:30 INFO:build_docs:   - en/elasticsearch/reference/7.16/modules-remote-clusters.html#sniff-mode
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.10/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.11/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.12/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.13/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.14/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.15/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.16/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.17/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/7.9/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/8.0/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/current/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license
15:21:30 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/enterprise-search/master/license-management.html contains broken links to:
15:21:30 INFO:build_docs:   - en/cloud-enterprise/current/ece-add-license.html#ece_add_a_license

I will work on fixing these.

@nrichers
Copy link

@elasticmachine run elasticsearch-ci/docs

@nrichers nrichers merged commit d9939cc into elastic:master Jan 12, 2022
@nrichers
Copy link

Looks to be live now, so I'm going to sign off for the evening:

image

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.

5 participants