fix: api docs build failure #751
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story. The labels on this github issue will be updated when the story is started. |
peterhaochen47
changed the title
peterhaochen47
changed the title
- problem: script `/scripts/generate_documentation_snippets.sh` fails with: ``` In plugin 'org.asciidoctor.convert' type 'org.asciidoctor.gradle.AsciidoctorTask' property 'logDocuments' is annotated with @optional but that is not allowed for 'Console' properties. ``` - It looks like our asciidoctor lib is out of date and not compatible with the new gradle. Hence, taking advice from asciidoctor/asciidoctor-gradle-plugin#600, migrate to a supported lib instead (`org.asciidoctor.jvm.convert`); and use the latest version of that. - The changes in this commit follows this sample app: https://github.com/spring-projects/spring-restdocs-samples/blob/c98c705ad9043aa19db96ce29160e0fbdfeaf8bc/restful-notes-spring-hateoas/build.gradle - note: The directory changes in `credhub/backends/credhub/src/docs/asciidoc/index.adoc` is required as part of this migration/upgrade; without these changes, the rendered doc html will not correctly import those "snippets". The new lib also seems to output the resulting html to a different dir, so update tasks and readme to reflect that. [#187494474]
peterhaochen47
force-pushed
the
pr/main/fix-asciidoctor-build
branch
from
cc8114d to
269a2b9
Compare
peterhaochen47
changed the title
|
Looks good to me. I don't have privilege to approve it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/scripts/generate_documentation_snippets.shfails with:
It looks like our asciidoctor lib is out of date (EOL) and not compatible
with the new gradle. Hence, taking advice from
Type 'AsciidoctorTask' property 'logDocuments' is annotated with @Optional but that is not allowed for 'Console' properties. asciidoctor/asciidoctor-gradle-plugin#600,
migrate to a supported lib instead (
org.asciidoctor.jvm.convert);and use the latest version of that.
The changes in this commit follows this sample app: https://github.com/spring-projects/spring-restdocs-samples/blob/c98c705ad9043aa19db96ce29160e0fbdfeaf8bc/restful-notes-spring-hateoas/build.gradle
note: The directory changes in
credhub/backends/credhub/src/docs/asciidoc/index.adocis required as part of this migration/upgrade; without these changes,
the rendered doc html will not correctly import those "snippets". The
new lib also seems to output the resulting html to a different dir,
so update tasks and readme to reflect that.
[#187494474]