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

Doxygen documenation automatic update on gh-pages #2282

Open
cvvergara opened this issue May 4, 2022 · 4 comments
Open

Doxygen documenation automatic update on gh-pages #2282

cvvergara opened this issue May 4, 2022 · 4 comments
Assignees
Labels
CI Conitnuous Integration Developers Doc.
Milestone

Comments

@cvvergara
Copy link
Member

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 cvvergara added Developers Doc. CI Conitnuous Integration labels May 4, 2022
@cvvergara cvvergara added this to the Release 3.3.2 milestone May 4, 2022
@krashish8
Copy link
Member

@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
Copy link
Member

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.

@cvvergara
Copy link
Member Author

Have to think.

@cvvergara
Copy link
Member Author

Moving up to 3.4.0 because I havent finished thinking

@krashish8 krashish8 modified the milestones: Release 3.4.0, Release 4.0.0 Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Conitnuous Integration Developers Doc.
Projects
None yet
Development

No branches or pull requests

2 participants