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

Push updated documentation through CI jobs #636

Merged
merged 4 commits into from
Nov 29, 2023
Merged

Push updated documentation through CI jobs #636

merged 4 commits into from
Nov 29, 2023

Conversation

giacomofiorin
Copy link
Member

Support updating the documentation directly from GitHub Actions. Currently, the doc Makefile already uses the current Git branch (or tag) to define the version of the code (added in #606).

This PR adds the necessary plumbing to push the documentation just built to the website's repository. In order to do so, we need the following:

  1. The commit message must include the string "[update-doc]"
  2. This commit must be at the head of a push, so that the CI jobs are triggered correctly.

The documentation is added to the website in a sub-folder with the same name as the branch, so that we can preview the documentation in a PR for review purposes. In between PRs, we may want to remove commits for these temporary branches from the website repository to avoid growing its size too much.

When pushing to master, Doxygen updates are pushed in addition to the manual.

I have already verified that the website was correctly updated by generating pages like this:
https://colvars.github.io/push-doc/colvars-refman-namd.html
Will now delete those files from the website repository before attempting to merge into master.

@giacomofiorin giacomofiorin added the documentation Only affects manual and other docs label Nov 29, 2023
@giacomofiorin giacomofiorin merged commit 14281bc into master Nov 29, 2023
17 checks passed
@giacomofiorin giacomofiorin deleted the push-doc branch November 29, 2023 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Only affects manual and other docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant