Links that need updating for a new cookbook created from this template

[brian-rose]

Documenting here all the boilerplate link URLs that should be updated from https://github.com/ProjectPythia/cookbook-template/ to the actual home and name of the new cookbook repo.

This should be handled automatically using the trigger-replace-links action as documented in the Cookbook guide, but things go wrong when the specific order of steps outlined in the guide are not followed. In particular, if you run that action before transferring the repo to the ProjectPythia organization, then the links will need manual updated.

Correcting the links to the cookbook repository

What we are really doing is replacing all instances of ProjectPythia/cookbook-template with ProjectPythia/[name of cookbook repo].

If a user has already run the trigger-replace-links action before transferring the repository to the ProjectPythia organization, then we will instead be replacing all instances of [github username]/[name of cookbook repo] with ProjectPythia/[name of cookbook repo].

A search-and-replace in a text editor will take care of this.

• Line 5 of README.md -- both the link to the badge icon and the link to the nightly-build.yaml in the same line
• Line 5 of notebooks/how-to-cite.md
• Line 46 of CITATION.cff (under the name field, the website field should point to "https://github.com/ProjectPythia/[name of cookbook repo]/graphs/contributors"
• Line 38 of _config.yml in the field repository_url:

The only instance of ProjectPythia/cookbook-template that should be skipped in a search-and-replace is in the workflow file .github/workflows/trigger-replace-links.yaml

Correcting the github.repository_id value in Zenodo links

Our Zenodo badge links for DOIs are keyed the unique values of github.repository_id. All instances of 475509405 (the id value for the template repository) should be replaced with the correct value of github.repository_id for that cookbook.

The two locations that need updating are:

• Line 7 of README.md
• Line 7 of notebooks/how-to-cite.md

Our trigger-replace-links action handles this automatically, but again if the steps are taken out of order then these badge links might not be functional.

[mgrover1]

@brian-rose - any trick around configuring permissions to get this to work? I keep getting a permissions error even though the repository settings are set properly

see ProjectPythia/esgf-cookbook#37

[brian-rose]

@brian-rose - any trick around configuring permissions to get this to work? I keep getting a permissions error even though the repository settings are set properly

see ProjectPythia/esgf-cookbook#37

No tricks should be needed beyond the steps described in the cookbook guide. I don't understand why it's not working in this case.

The workaround is a manual edit of the links, as described above in this issue.