pgrouting icon indicating copy to clipboard operation
pgrouting copied to clipboard

Doxygen documenation automatic update on gh-pages

Open cvvergara opened this issue 3 years ago • 4 comments

Currently the doxygen (developers documentation) is not been updated automatically on gh-pages.

https://github.com/pgRouting/pgrouting/blob/develop/.github/workflows/locale-and-website.yml#L98

  • For branch master only
  • build/doxygen/html/ to doxygen

cvvergara avatar May 04 '22 01:05 cvvergara

@cvvergara Is it okay to update the developers documentation on every commit to the main branch? Or will it be better to do it whenever a release is made of the main branch?

The release actions currently updates the developers documentation on release of the main branch: https://github.com/pgRouting/pgrouting/blob/develop/.github/workflows/release.yml#L114

I'll just need to change env.BRANCH to "main" instead of "master" in that action, as this was missed when we renamed the branches. Otherwise this should work

krashish8 avatar May 11 '22 14:05 krashish8

I see that in vrpRouting, we do it for every commit, because we have developers documentation for both main and develop: https://github.com/pgRouting/vrprouting/blob/main/.github/workflows/locale-and-website.yml#L153

In pgRouting, we have the developers documentation only for the main branch.

krashish8 avatar May 11 '22 14:05 krashish8

Have to think.

cvvergara avatar May 12 '22 15:05 cvvergara

Moving up to 3.4.0 because I havent finished thinking

cvvergara avatar Aug 21 '22 17:08 cvvergara