-
Notifications
You must be signed in to change notification settings - Fork 637
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
Antora ci #1046
base: main
Are you sure you want to change the base?
Antora ci #1046
Conversation
…d only for samples CI.
@gpx1000 @martyj @TomAtkinsonArm trying to diagnose the publishing problem. First, there is an existing CI job jekyll-gh-pages.yml which already tries to publish there but fails. I do not know if this is intended to work, ever did work, or needs to work. It was created by @TomAtkinsonArm over a year ago according to git - Tom, can you comment? Without digging down into the details of the jekyll-gh-pages job, what it attempts to do is publish a subset of the repository files AFAICT. Second, re authorizing the new Antora CI in this PR, the first thing I notice in the repo settings is that Pages "Build and deployment" is set to source "Github Actions". By contrast the Vulkan-Site settings uses source "Deploy from a branch". It's possible that changing this setting could address the permissions problem, and it would get us onto the same path as Vulkan-Site which does work. Changing it would probably break the jekyll job above even more than it's already broken, but since it's not working anyway, I propose to make that change as a first step. |
Imo we should do exactly that. The github page deployment was an early attempt at publishing some form of documentation. We never really made that public and it probably doesn't work at all with asciidoc. |
100% agree, we should retire the current GitHub job in favor of this. |
@gpx1000 I was skimming over the recent minutes and noticed you commented "Waiting on Jon - I don’t have permissions to deprecate the path…unless someone has reason to keep github pages…". But I don't see a specific ask above? How about if:
|
@SaschaWillems @gpx1000 it would be great to progress this. It's difficult for me even to pull the entire Samples repo, much less successfully set it up for Antora. The former might be network issues but I'm pretty certain the latter is because there are so many external submodules that can easily themselves have build problems. I'm not sure how the submodules are setup, but these problems are so difficult to diagnose from my PoV that I think we should be locking the Antora builds to specific known-good repository commits and submodule commits going forward. Having CI setup to validate the Antora build at a specific point in time should be helpful in that regard. |
I'd love to help, but no idea what to do or if I can do anything at all (in regards to this issue). We talked about this on the last call. @gpx1000: What needs to be done to fix this? |
Yep, this is on my todo list. I just need to edit the project settings in the github repo. |
see if granting permissions in the workfile solves issue.
*maybe* this will let us use the existing environment for deploying?
Description
This adds building the antora documentation to the CI for Vulkan Samples. This way we can capture any problems with the future changes to tutorials that are automatically harvested in creating the vulkan documentation site.
Fixes #1040
KhronosGroup/Vulkan-Site#82
NB: to see example of the build here:
https://gpx1000.github.io/Vulkan-Samples/samples/latest/README.html
When this is merged, the build job should publish to here:
Note that to make this work, need to change the settings for the repo to publish form the gh-pages branch.
https://khronosgroup.github.io/Vulkan-Samples/samples/latest/README.html