Upload a GitHub release to Zenodo

This is a Github action to update your codemeta.json, CITATION.cff and .zenodo.json files with the release information and then upload your release to Zenodo.

This action uses the tag name of the release to update the version field in the metadata files. Be sure to use the correct tag name. Within your tag name a valid semver version should be present.

When update metadata files are added to your repository, the action will automatically send the new metadata files in its release. This will also mean that your Github release will not contain the updated metadata files. To avoid this, you can set the update_metadata_files option to false and add a .zenodo.json file.

Remember to remove the webhook from your repository before using this action. Otherwise, you will have two releases on Zenodo for every release on Github.

Currently the following files and fields will be updated:

* `codemeta.json`:
    * `version`: The release version
    * `identifier`: The release identifier (Zenodo version specific doi)

* `CITATION.cff`:
    * `version`: The release version
    * `identifiers`: The release identifier (Zenodo version specific doi).
    This action currently assumes your old zenodo doi is the first item in the list.

* `.zenodo.json`:
    * `version`: The release version

* `docs.compatibility.json`
    * A new entry will be added in this file. This entry is meant for versioned Docusaurus projects
        * `docsVersion` - The new docs version
        * `appVersion` - The latest app version

Inputs

A list of all inputs to the action is as follows:

github_token - Required - The GitHub token used to authenticate with GitHub. If not present, the action will attempt to read the token from the GITHUB_TOKEN environment variable.

zenodo_token - Required - The Zenodo token used to authenticate with Zenodo.

zenodo_deposition_id - Required - The Zenodo deposition ID to upload the release to.

zenodo_publish - Optional - Whether to publish the release. Defaults to false.

zenodo_sandbox - Optional - Whether to use the Zenodo sandbox. Defaults to false.

committer_name - Optional - The name of the committer.

committer_email - Optional - The email of the committer.

commit_message - Optional - The commit message. Defaults to chore: update ${file_name} for Zenodo release. You can use the ${file_name} variable to refer to the metdata file name in the commit message.

update_metadata_files - Optional - Whether to update the metadata files. Defaults to true. This will also push the changes to GitHub.

codemeta_json - Optional - Whether a codemeta.json file exists in the repository and needs to be updated for the new release. Defaults to false.

citation_cff - Optional - Whether a CITATION.cff file exists in the repository and needs to be updated for the new release. Defaults to false.

zenodo_json - Optional - Whether a .zenodo.json file exists in the repository and needs to be updated for the new release. Defaults to false.

docs_compatibility_json - Optional - Whether a docs.compatibility.json file exists in the repository and needs to be updated for the new release. Defaults to false.

Outputs

doi - The Zenodo DOI of the release.

version - The version of the release.

Example usage

A sample action is shown below.

name: Release on Zenodo

on:
  release:
    types: [published]

jobs:
  upload-to-zenodo:
    runs-on: ubuntu-latest
    name: A job to update metadata and push a release to Zenodo

    steps:
      # This step is not needed at the moment but might decide to add on more steps in the future
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: 16

      - name: Upload to Zenodo
        id: release
        uses: megasanjay/[email protected]
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          zenodo_token: ${{ secrets.ZENODO_TOKEN }}
          zenodo_deposition_id: SOME_DEPOSITION_ID
          zenodo_publish: true
          zenodo_sandbox: false
          commit_message: 'chore: update ${file_name} for Zenodo release'
          update_metadata_files: true
          codemeta_json: true
          citation_cff: true
          zenodo_json: true

      # Get the doi from the `release` step
      - name: Get the output doi
        run: echo "The released doi was ${{ steps.release.outputs.doi }}"

Build and release instructions

To build and release a new version of the action, run the following commands:

npm install
npm run build

git commit -a -m "chore: release action v1.2.3"
git tag -a -m "Action v1.2.3 release" v1.2.3
git push --follow-tags

needs to be generalized so action can run from branches other than `main`

I am testing this action to upload to the Zenodo sandbox in a separate branch (beta_prep), so as not to contaminate the main branch until it's ready to go, and I was puzzled by the failures to find the .zenodo.json file:

https://github.com/alexlancaster/pypop/actions/runs/6269876124/job/17026982885#step:3:18

Then I realized that it's looking for:

https://api.github.com/repos/alexlancaster/pypop/contents/.zenodo.json

which doesn't (yet) exist in the main branch, however if the URL is changed to include the branch beta_prep using ref:

https://api.github.com/repos/alexlancaster/pypop/contents/.zenodo.json?ref=beta_prep

This looks pretty straightforward to solve, but I lack the Javascript skills. Also it makes me think that this also may need adjusting on the commit side as well. It may try and commit to the main branch. Either way the action needs to be updated to take into account. I can try and fork the repo and hack it until it works and submit a PR if that's helpful.

megasanjay / upload-to-zenodo Goto Github PK

upload-to-zenodo's Introduction

Upload a GitHub release to Zenodo

Inputs

Outputs

Example usage

Build and release instructions

upload-to-zenodo's People

Contributors

Stargazers

Watchers

Forkers

upload-to-zenodo's Issues

Rate-Limited

Edited/Blocked

Open

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org