Create trigger to update book.oceaninfohub.org from master

iodepo / odis-arch

Development of the Ocean Data and Information System (ODIS) architecture

https://book.oceaninfohub.org/

26 stars 16 forks source link

Create trigger to update book.oceaninfohub.org from master #425

Open jmckenna opened 2 months ago

jmckenna commented 2 months ago

Status as I see it now:

there is a deploy-book GitHub action in this repo
it is currently triggered when a new push/commit is made into the publication branch (see yaml config)
however no updates to that publication branch have been made since 6 months ago - meaning that https://book.oceaninfohub.org/ is 6 months old, lacking all of the changes in that timeframe
a simple change to the yaml could be made to have the book deployed whenever a commit is made to the master branch, instead of the publication branch
in the long run, we cannot rely on manual deploy-book/merges made into publication, instead, we should set this up that it runs on its own

cc @fils @pbuttigieg for thoughts on how to have this run automatically

pbuttigieg commented 1 month ago

As discussed, the published version should not be changed without review, but we do want to make that more rapid and automatic.

The solution is to use normative GH practice:

changes that affect the book should only be made on a branch linked to an issue
A PR should then be made and reviewed by the relevant parties (this will vary based on content, but I should have overview on all PRs at this stage).
Once the PR is approved, it can be merged into the master branch
That merge action - into the book directory of odis-arch master - should trigger the publish workflow

I think this will work.

I'm less sure on how the relationship with odis-in embeds works here. If they change, this may not be picked up by the process above.

This shoud be okay as long as editing on odis-in content is very disciplined and it remains a repo with low content variation in each of its directories

jmckenna commented 3 weeks ago

updates:

added a new GitHub action that will merge master into the publication branch once a week, on Sundays (that then triggers a book rebuild)
weekly-publish.yml
- we can easily change the schedule to daily or whatever we want
- we can also easily now run that action manually, through the Actions menu above