https://github.com/xuanxu/upload-files-action

This action uploads paper files (PDF/JATS/Crossref) to its own branch in the papers repository
https://github.com/xuanxu/upload-files-action

Last synced: 6 days ago
JSON representation

This action uploads paper files (PDF/JATS/Crossref) to its own branch in the papers repository

• Host: GitHub
• URL: https://github.com/xuanxu/upload-files-action
• Owner: xuanxu
• License: mit
• Created: 2022-01-21T11:03:37.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T09:50:33.000Z (5 months ago)
• Last Synced: 2024-12-10T01:41:58.440Z (13 days ago)
• Language: Ruby
• Size: 21.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Open Journals :: Upload files

This action creates a topic branch for a paper in the corresponding Open Journal's papers repository and adds the paper files (pdf/jats/crossref xml) to it.

## Usage

Usually this action is used as a step in a workflow that also includes other steps for generating the paper files.

### Inputs

The action accepts the following inputs:

- **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.

- **pdf_path**: Optional. The path to a paper pdf file to add to the paper's branch.

- **crossref_path**: Optional. The path to a crossref xml file with the deposit metadata to add to the paper's branch.

- **jats_path**: Optional. The path to a jats file with the paper metadata to add to the paper's branch.

- **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 the following outputs:

- **pdf_html_url**: The HTML URL for the uploaded PDF file

- **pdf_download_url**: The direct download URL for the uploaded PDF file

- **crossref_html_url**: The HTML URL for the uploaded Crossref XML file

- **crossref_download_url**: The direct download URL for the Crossref XML file

- **jats_html_url**: The HTML URL for the 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 for uploading just pdf and crossref files, showing how to pass input values from diferent sources: workflow inputs, secrets or directly).

````yaml

on:

  workflow_dispatch:

   inputs:

      issue_id:

        description: 'The issue number of the submission'

jobs:

  processing:

    runs-on: ubuntu-latest

    env:

      GH_ACCESS_TOKEN: ${{ secrets.BOT_TOKEN }}

    steps:

      - name: Upload file to papers repo

        uses: xuanxu/upload-files-action@main

        with:

          papers_repo: myorg/myjournal-papers

          branch_prefix: myjournal

          issue_id: ${{ github.event.inputs.issue_id }}

          pdf_path: docs/paper.pdf

          crossref_path: docs/paper.jats

```