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

Add GitHub Actions workflow to build and publish docs to GitHub Pages #388

Merged
merged 1 commit into from
Apr 6, 2024

Conversation

esabol
Copy link
Member

@esabol esabol commented Mar 30, 2024

This PR adds a GitHub Actions workflow to build and publish docs to GitHub Pages.

No idea if this will work. GitHub Actions are difficult to test before merging. I did test building the docs in a local Docker container, but there are many differences with the GitHub Actions environment.

@esabol esabol force-pushed the build-and-publish-docs branch from e31c15b to c2417a6 Compare March 30, 2024 23:51
@esabol esabol mentioned this pull request Mar 30, 2024
@esabol esabol force-pushed the build-and-publish-docs branch from c2417a6 to 561a251 Compare March 31, 2024 00:03
@SpamapS
Copy link
Member

SpamapS commented Apr 5, 2024

I'm a little confused.. where does this publish to?

@esabol
Copy link
Member Author

esabol commented Apr 6, 2024

I'm a little confused.. where does this publish to?

The GitHub Pages URL for a given repository is always https://{userid}.github.io/{reponame}, so it should publish to https://gearman.github.io/gearmand.

@SpamapS
Copy link
Member

SpamapS commented Apr 6, 2024

Cool, well let's see what it does!

@SpamapS SpamapS merged commit 5411573 into gearman:master Apr 6, 2024
12 checks passed
@SpamapS
Copy link
Member

SpamapS commented Apr 6, 2024

https://gearman.org/gearmand/ has the docs! I had to bump the version of upload-pages-artifact which was confusingly annoying (see latest commit in master). Anyway, thanks! If you want to add links to it to the website you should have access to that repo as well. https://github.com/gearman/gearman.github.io just make the links relative.. to /gearmand.

@esabol esabol deleted the build-and-publish-docs branch April 6, 2024 19:14
@esabol
Copy link
Member Author

esabol commented Apr 6, 2024

I'm surprised I got so close to getting it fully working before it was merged!

Need to upgrade to actions/configure-pages@v5 to eliminate the Node16 deprecation warning. And the environment needs a tweak, I think. I'll submit another PR soon.

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

Successfully merging this pull request may close these issues.

2 participants