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

Use GitHub Actions to build documentation #24

Closed
bquorning opened this issue Jun 11, 2024 · 8 comments
Closed

Use GitHub Actions to build documentation #24

bquorning opened this issue Jun 11, 2024 · 8 comments
Assignees

Comments

@bquorning
Copy link
Contributor

Pulling repositories and building documentation takes 10–13 minutes on my very fast laptop, and I don’t know if there’s any way to speed it up. So I was thinking if we could at least move the work to GitHub Actions, meaning that I would only need to update the playbook file and then GHA would do the actual work – is that possible?

@bquorning
Copy link
Contributor Author

cc @bbatsov

@bbatsov
Copy link
Contributor

bbatsov commented Jun 11, 2024

Yeah, it's possible, I just never got to doing it - https://docs.antora.org/antora/latest/publish-to-github-pages/#using-github-actions

@bquorning
Copy link
Contributor Author

It looks like you’re currently working on this issue @bbatsov 🎉

@bbatsov
Copy link
Contributor

bbatsov commented Feb 16, 2025

Oh, I had forgotten we had an issue about this. :D Yeah, I finally told myself that enough is enough and this needs to be properly automated.

The new job seems to be working properly, so I'll close this ticket.

@bbatsov bbatsov closed this as completed Feb 16, 2025
@bquorning
Copy link
Contributor Author

I am not sure it works actually. I'm seeing at least some dead links on https://docs.rubocop.org/ but I can't have a closer look just now.

@bquorning
Copy link
Contributor Author

Also the documented Docker command doesn't work.

@bbatsov bbatsov reopened this Feb 16, 2025
@bbatsov
Copy link
Contributor

bbatsov commented Feb 16, 2025

Also the documented Docker command doesn't work.

It was submitted by someone else, so I haven't tried it.

I am not sure it works actually. I'm seeing at least some dead links on https://docs.rubocop.org/ but I can't have a closer look just now.

I think that's something to do with the use of latest that I attempted. I'm puzzled why this doesn't work. (see https://docs.antora.org/antora/latest/playbook/urls-latest-version-segment-strategy/) I'll change it back to a hardcoded version and I think it will fix the index.

@bquorning
Copy link
Contributor Author

You can leave the Docker command to me, I'll try to fix it.

@bbatsov bbatsov closed this as completed Feb 23, 2025
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

2 participants