search

materialsproject / matbench

Matbench: Benchmarks for materials science property prediction
https://matbench.materialsproject.org
MIT License
123 stars 47 forks source link

Need to upgrade to newer version of EndBug add-and-commit soon, as features from v7 are being deprecated #260

Open ardunn opened 1 year ago

ardunn commented 1 year ago

https://github.com/EndBug/add-and-commit

hrushikesh-s commented 1 year ago

It looks like only this line needs to be updated. As described here, I'm setting up the GH Action for my forked repo. Will check for potential errors upon upgrading the add-and-commit from v7 to v9.1.3, once I successfully setup the GH action.

Also, I'd a conversation with @janosh who suggested that we may push directly using git. for eg: this. @ardunn , is there any specific reason for using EndBug/add-and-commit?

ardunn commented 1 year ago

@hrushikesh-s yes, it's so there is never a scenario where the docs/website don't represent the actual benchmark data.

Without this commit and push action, the workflow for updating looks like this:

  1. Developer merges in benchmark PR.
  2. Developer pulls repo changes to local branch
  3. Developer regenerates documents
  4. Developer pushes docs to GitHub
  5. GitHub deploys website

With this commit and push action, the workflow for updating looks like this (in theory, in practice it occasionally breaks):

  1. Developer merges in benchmark PR.
  2. GitHub automatically regenerates docs and deploys updated website.

With that in mind, I'm open to other ways of managing this. I just want the website and the bmark data to be in sync to avoid developer (ie, us) headache. Suggestions? @janosh @hrushikesh-s

ardunn commented 1 year ago

Oh, I did not see that link you posted essentially takes care of the problem. If we can put in a workflow script to take care of it automatically, I'm fine with that. I just want it to work