Boil down first CI tutorial#180
Conversation
|
Shoudl add a link to concept DOI in the last paragraph, pointing to Zenodo's "versioning DOIs" docs. |
Done in a5c2b08. |
jkelling
left a comment
jkelling
left a comment
There was a problem hiding this comment.
Looks good, apart from the ["cff, "git"] harvest order.
Does the folder .hermes/curate remain in the repo after the publication PR is merged?
poikilotherm
left a comment
poikilotherm
left a comment
There was a problem hiding this comment.
I took the liberty of adding some more subtle changes. Hope this is to your liking, especially the workflow diagram. Tune as you see fit - otherwise good to go!
Cheers, I finetuned a bit. Will merge once the CI build is done. |
led02
left a comment
led02
left a comment
There was a problem hiding this comment.
note: I found some inconsistencies. This might be due to unclear wording. Yet, it does not correctly describe the process.
| [harvest.cff] | ||
| validate = false |
There was a problem hiding this comment.
Is there a good reason to switch off CFF validation here?
There was a problem hiding this comment.
Only that it was copied from showcase (which I don't think has "version" perhaps?). Happy to remove.
| Copy the [template for GitHub to Zenodo Sandbox publication](https://github.com/hermes-hmc/ci-templates/blob/main/TEMPLATE_hermes_github_to_zenodo.yml) | ||
| into the `.github/workflows/` directory in your repository, and rename it as you like (e.g. `hermes_github_to_zenodo.yml`). | ||
|
|
||
| Go through the file, and look for comments marked with `# ADAPT`. |
There was a problem hiding this comment.
Maybe this is just a litte too lazy. I would exprect at least some synopsis what and why to adapt...
There was a problem hiding this comment.
Didn't want to overburden the tutorial for this. Once we have a cleaner template (e.g. based on Marketplace Action), we can pull this in here.
| ```{warning} | ||
| If you haven't adapted the workflow file, and push it to the branch `main`, you will create an automatic publication at this point. | ||
| ``` |
There was a problem hiding this comment.
This is not true: We create a new PR that needs to be closed before the publication is done (i.e., "curation step").
| Now, whenever the GitHub Actions workflow is triggered, it will publish a new version of your repository to Zenodo Sandbox. | ||
| If you haven't adapted the workflow file, this will happen whenever you push to your `main` branch. |
There was a problem hiding this comment.
Again: No, it only creates the curation PR that needs to be merged before the deposition takes place.
| If the updates from the publication actually change the configuration file, or the `CITATION.cff` file, | ||
| HERMES will create another pull request after publication. |
There was a problem hiding this comment.
This reads rather cryptic... it's not the updates from the publication but the postprocessing that changes stuff...
4 participants
Tihs PR prepares a working tutorial for using GitHub Zenodo Sandbox publication via a template.