Skip to content
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

A clean build leads to "Failed to download playbook" #30481

Closed
rstoyanchev opened this issue May 12, 2023 · 1 comment
Closed

A clean build leads to "Failed to download playbook" #30481

rstoyanchev opened this issue May 12, 2023 · 1 comment
Assignees
Labels
status: superseded An issue that has been superseded by another type: task A general task
Milestone

Comments

@rstoyanchev
Copy link
Contributor

$ ./gradlew clean build
> Task :framework-docs:antora FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':framework-docs:antora'.
> Failed to calculate the value of task ':framework-docs:antora' property 'args'.
   > Failed to download playbook from specified provider { host = 'github.com' repository = 'spring-projects/spring-framework' branch = 'docs-build' path = 'lib/antora/templates/per-branch-antora-playbook.yml' }.

This looks related to the recent change #30465 to download to the build directory. The antora task seems to download the playbook quite early as part of registration. I can see in the logs the playbook is successfully retrieved, but the build directory probably doesn't exist yet.

Removing the dependency on "check" it no longer fails. However, the task also no longer gets run as part of the build to flag potential documentation issues.

I'm not sure if there is room for improvement on the Antora side. I find that both the "check" to "antora" dependency as well as the choice to cache the playbook under the build directory are reasonable choices.

@rstoyanchev rstoyanchev added the type: task A general task label May 12, 2023
@rstoyanchev rstoyanchev added this to the 6.0.10 milestone May 12, 2023
rstoyanchev added a commit that referenced this issue May 12, 2023
rstoyanchev added a commit that referenced this issue May 23, 2023
Instead of having antora run always, which happens regardless of
whether anything has changed, we'll have it invoked as part of the CI
build, and we'll have to run it locally ourselves when necessary.

See gh-30481
@rstoyanchev
Copy link
Contributor Author

We've decided to revert the change to download the playbook to the build directory, as well as to remove the task dependency from "check" to "antora", also because it runs every time (regardless of changes) and it is not very fast. Instead we'll have the "antora" task run as part of the CI build, or otherwise we'll run it manually locally.

rstoyanchev added a commit that referenced this issue May 23, 2023
rstoyanchev added a commit that referenced this issue May 23, 2023
@rstoyanchev rstoyanchev closed this as not planned Won't fix, can't repro, duplicate, stale May 23, 2023
@rstoyanchev rstoyanchev self-assigned this May 23, 2023
@rstoyanchev rstoyanchev added the status: superseded An issue that has been superseded by another label May 23, 2023
mdeinum pushed a commit to mdeinum/spring-framework that referenced this issue Jun 29, 2023
mdeinum pushed a commit to mdeinum/spring-framework that referenced this issue Jun 29, 2023
Instead of having antora run always, which happens regardless of
whether anything has changed, we'll have it invoked as part of the CI
build, and we'll have to run it locally ourselves when necessary.

See spring-projectsgh-30481
mdeinum pushed a commit to mdeinum/spring-framework that referenced this issue Jun 29, 2023
mdeinum pushed a commit to mdeinum/spring-framework that referenced this issue Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: superseded An issue that has been superseded by another type: task A general task
Projects
None yet
Development

No branches or pull requests

1 participant