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

Add GitHub action to build static site #170

Merged
merged 4 commits into from
Mar 12, 2021

Conversation

cthoyt
Copy link
Collaborator

@cthoyt cthoyt commented Mar 12, 2021

Closes #167

This PR adds a new GitHub actions workflow which does the following on a cron job (and optionally on command via the workflow_dispatch option):

  1. checks out the master branch
  2. installs the local package (plus indra for now, up for discussion)
  3. runs the exporter that generates the static site in the docs/ folder
  4. makes a commit
  5. pushes to the master branch of sorgerlab/famplex
  6. dance party

This PR also fixes the display of descriptions on term pages (see ff16d7c).

parrot

Discussion

  • How to test stuff like this, since it needs to be on master to run?
  • Is it okay to run with indra as a requirement?
  • What frequency is best for cron? Daily might be overkill - weekly could be better.
  • Which party parrot is best?

@cthoyt cthoyt requested a review from bgyori March 12, 2021 17:58
@bgyori
Copy link
Member

bgyori commented Mar 12, 2021

  • I think installing INDRA isn't a problem but loading the ontology graph might be, due to memory constraints - we'd have to try running the action to see what happens.
  • Would it make sense to run the website from another branch and push to that branch instead of master?
  • I haven't done anything like this before but is it possible to trigger the action when something is pushed to sorgerlab/master instead of a fixed cron timer? If not, a weekly build would be good.
  • I've never seen such a large version of the party parrot, nice!

@cthoyt
Copy link
Collaborator Author

cthoyt commented Mar 12, 2021

I guess we could give it a shot and see what happens, the only thing to change would be removing the install line for INDRA if it doesn't work.

I've seen other sites that run from a branch instead of master. I find this pretty confusing and opaque.

Yes, we could have it trigger on push instead. That's actually quite simple, and how most testing works anyway. Since most work is done in branches/pull requests then it won't have to run too often. I will do that

See https://cultofthepartyparrot.com/

@cthoyt
Copy link
Collaborator Author

cthoyt commented Mar 12, 2021

@bgyori It will only run on pushes to master as of b9ea79f. Should we merge this to see what happens?

@bgyori bgyori merged commit 9187f89 into sorgerlab:master Mar 12, 2021
@cthoyt cthoyt deleted the add-site-build-gha branch March 12, 2021 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate update of static site with GHA
2 participants