search

postgrespro / pgsphere

PgSphere provides spherical data types, functions, operators, and indexing for PostgreSQL.
https://pgsphere.org
BSD 3-Clause "New" or "Revised" License
16 stars 15 forks source link

Add pipeline for docs using GitHub Pages #73

Closed borodun closed 9 months ago

borodun commented 9 months ago

Build and deploy docs to GitHub Pages. This workflow will deploy for master branch. For now, it hosts doc/html directory, so only the last version will be available. How necessary is it to organize the deployment of documentation with previous versions?

borodun commented 9 months ago

@esabol, I've tested it on my fork by removing branches: master: https://github.com/borodun/pgsphere/actions/runs/6339680394. Docs were deployed to https://borodun.github.io/pgsphere/.

esabol commented 9 months ago

So what's the URL of the GitHub Pages documentation? We should add this URL to the README and possibly the documentation itself, I think. And the "About" box on the front page of the repository.

I tried https://postgrespro.github.io/pgsphere/ and got a 404 error, so that must not be it?

vitcpp commented 9 months ago

@esabol, @borodun It should be https://postgrespro.github.io/pgsphere/ . It worked yesterday before the last merge. But it displays 404 now unfortunately. We will check and fix it. It may be the result of the changes in the master branch (changed version number). Thank you for reporting!

borodun commented 9 months ago

@esabol, @vitcpp It looks like the following job https://github.com/postgrespro/pgsphere/actions/runs/6403043991 (default Jekyll workflow) was executed after https://github.com/postgrespro/pgsphere/actions/runs/6403044188 and erased all static files. After re-run, docs appeared again on https://postgrespro.github.io/pgsphere/. We need to disable this workflow: https://github.com/postgrespro/pgsphere/actions/workflows/pages/pages-build-deployment. Seems like it was added due to mistake in repo setting, because it doesn't have a corresponding workflow file in .github/workflows directory.

esabol commented 9 months ago

I was reading the documentation on this yesterday, and it said something about creating a .nojekyll file. I didn't understand why, but maybe this is the reason?

borodun commented 9 months ago

@esabol, thank you! As I understand from the docs, this file is only used when publishing Github Pages from a branch. We have tried to change repo settings to use Github Actions to publish Pages. We will see if this helped when new commits will be added to master. So, for now, this file won't be necessary, I think.