upload-metadata-action's Introduction

Open Journals :: Upload metadata file

This action adds a JATS file to a paper branch in the corresponding Open Journal's papers repository

Usage

Usually this action is used as a step in a workflow after the pdf file and the paper's branch are created.

Inputs

The action accepts the following inputs:

jats_path: Required. The path to the jats file with the paper metadata
papers_repo: Required. The repository containing the published and submitted papers in owner/reponame format.
issue_id: Required. The issue number of the submission of the paper.
branch_prefix: Optional. The prefix of the name of the paper's branch.
bot_token: Optional. The GitHub access token to be used to upload files. Default: ENV['GH_ACCESS_TOKEN']

Outputs

If the action runs successfully it generates four outpus:

crossref_html_url: The HTML URL for the newly uploaded Crossref XML file
crossref_download_url: The direct download URL for the Crossref XML file
jats_html_url: The HTML URL for the newly uploaded JATS file
jats_download_url: The direct download URL for the JATS file

Example

Use it adding it as a step in a workflow .yml file in your repo's .github/workflows/ directory and passing your custom input values (here's an example showing how to pass input values from diferent sources: workflow inputs, secrets or directly).

on:
  workflow_dispatch:
   inputs:
      issue_id:
        description: 'The issue number of the submission'
jobs:
  processing:
    runs-on: ubuntu-latest
    steps:
      - name: Upload file to papers repo
        uses: xuanxu/upload-metadata-action@main
        with:
          papers_repo: myorg/myjournal-papers
          branch_prefix: myjournal
          issue_id: ${{ github.event.inputs.issue_id }}
          jats_path: docs/paper.jats
          bot_token: ${{ secrets.BOT_ACCESS_TOKEN }}
```

Recommend Projects