Skip to content

upgrade Antora plugin and configure playbook provider to support local build #12500

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

Conversation

mojavelinux
Copy link
Contributor

No description provided.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 6, 2023
@mojavelinux mojavelinux force-pushed the set-up-playbook-provider-5.6.x branch from 3b7ab39 to ee414d0 Compare January 6, 2023 23:32
@rwinch rwinch marked this pull request as draft January 10, 2023 15:06
@mojavelinux mojavelinux force-pushed the set-up-playbook-provider-5.6.x branch from ee414d0 to 76966aa Compare January 11, 2023 08:02
@mojavelinux
Copy link
Contributor Author

This PR can be merged as soon as #12522 is merged (which provides the template).

@mojavelinux mojavelinux marked this pull request as ready for review January 11, 2023 08:02
@mojavelinux mojavelinux force-pushed the set-up-playbook-provider-5.6.x branch from 76966aa to cfcab85 Compare January 11, 2023 08:03
@mojavelinux
Copy link
Contributor Author

mojavelinux commented Jan 11, 2023

With this change, it will no longer be necessary for the author to maintain or modify the playbook per content/software branch. Instead, the playbook for this context is managed centrally in the docs-build branch.

The plugin will sideload or download the template to cached-antora-playbook.yml. If that file is already present, that copy will be used instead (for offline builds, etc). This also allows the author to play around with the playbook if desired. To get a fresh copy, the author can delete the file and the plugin will retrieve a fresh copy.

@mojavelinux mojavelinux force-pushed the set-up-playbook-provider-5.6.x branch from cfcab85 to 92a6f8c Compare January 13, 2023 21:34
@mojavelinux
Copy link
Contributor Author

@rwinch I have updated this PR so it only contains the configuration to switch to the managed local build controlled by the playbook provider.

Note that the Gradle Antora Plugin now requires Java 17, so it's necessary to switch to Java 17 to run Antora within the branch. (It does not impact the production build since it runs everything using Java 17). If this is a problem, please file an issue in the Gradle Antora Plugin and we can discuss it.

@mojavelinux
Copy link
Contributor Author

mojavelinux commented Jan 13, 2023

Based on what CI is telling me, this is going to be a problem since it causes the main build to fail. I'll post back once I roll out a new alpha.

FYI, it's no longer necessary to having the antora task run as part of the main build since the antora task in a branch is only for author preview. But I can understand that you want to verify that it works for when the author needs it, so I supposed it's not unreasonable to run it in CI. But I wouldn't be bothering the devs with it as part of their main build...or as part of a distribution build.

@mojavelinux mojavelinux force-pushed the set-up-playbook-provider-5.6.x branch from 92a6f8c to a600ffd Compare January 13, 2023 22:22
@mojavelinux
Copy link
Contributor Author

I've upgrade to a version of the plugin that is compatible with Java 11. This PR is now ready.

@marcusdacoregio marcusdacoregio self-assigned this Jan 17, 2023
@marcusdacoregio marcusdacoregio added in: docs An issue in Documentation or samples type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Jan 17, 2023
@marcusdacoregio marcusdacoregio merged commit 22ffa83 into spring-projects:5.6.x Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: docs An issue in Documentation or samples type: enhancement A general enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants