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

Provide a way to do partial local subproject builds #720

Closed
djencks opened this issue Dec 15, 2021 · 5 comments
Closed

Provide a way to do partial local subproject builds #720

djencks opened this issue Dec 15, 2021 · 5 comments

Comments

@djencks
Copy link
Contributor

djencks commented Dec 15, 2021

Subprojects need to be able to check their documentation reasonably quickly without doing a full Antora build. The current approach of having customized playbooks for each subproject doesn't work.

One clear requirement is that local partial builds must be based on the actual camel-website full build.

I have a POC that I will discuss on the dev list.

@djencks
Copy link
Contributor Author

djencks commented Dec 20, 2021

I've added this to all the active main camel and camel-quarkus branches (except main 2.x, which I presume is not really active) and haven't seen other comments, but I've found it really useful.

As part of #701 I expect to be touching every active branch of every subproject shortly so I will add this local-build setup to the remaining subprojects.

@djencks
Copy link
Contributor Author

djencks commented Dec 21, 2021

I'm planning to document how to use this on https://camel.apache.org/manual/improving-the-documentation.html, and replace the subproject docs/README.* with a pointer to that plus any subproject specific instructions.

I'm thinking of naming the local instructions README_local_build.adoc to make it clear what they are for.

@djencks
Copy link
Contributor Author

djencks commented Dec 29, 2021

As part of #731 I've revised the scripts and setup for local builds, and the 32 PRs for all subprojects + updated docs are listed there.

@djencks
Copy link
Contributor Author

djencks commented Dec 31, 2021

I think this is now complete.

@djencks djencks closed this as completed Dec 31, 2021
@djencks
Copy link
Contributor Author

djencks commented Jan 3, 2022

I think this is done.

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

No branches or pull requests

1 participant