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

Consistent repo versioning #59

Closed
4 tasks
durack1 opened this issue Jul 29, 2024 · 3 comments · Fixed by #71
Closed
4 tasks

Consistent repo versioning #59

durack1 opened this issue Jul 29, 2024 · 3 comments · Fixed by #71

Comments

@durack1
Copy link
Contributor

durack1 commented Jul 29, 2024

We want to label the version of the repo consistently and clearly, so the following will need to be updated each time a release is minted

  • README.md
  • CITATION.cff
  • All docs/*.html files
  • Repo itself

Note to self, there is some code in 07653ab that was lost but could be recovered which solves the README.md and CITATION.cff updates. The HTML files are currently written using a script, which takes the version as an argument, so that's also close to being implemented

@znichollscr
Copy link
Collaborator

Notes on the solution in #71:

Everything is fine, except CITATION.cff. There's a circular dependency on having the version in there. You need the Zenodo URL to write the CITATION.cff file, and you need the repo state (including CITATION.cff) to create the Zenodo URL. I've broken this circularity by making CITATION.cff point at the Zenodo 'all versions' URL and then telling people to use the more specific version DOI if they need to cite a specific version. I think that should be fine.

@durack1
Copy link
Contributor Author

durack1 commented Aug 5, 2024

@znichollscr you can use the persistent DOI: 10.5281/zenodo.12629796, this isn't tied to the version, but rather is a "master" DOI that always points to the latest - voila

@znichollscr
Copy link
Collaborator

Yep cool I think that's what I've done, I just didn't explain it very well. See the current state of the citation file here: https://github.com/PCMDI/input4MIPs_CVs/blob/main/CITATION.cff

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 a pull request may close this issue.

2 participants