https://github.com/xuanxu/preprint-action

GitHub Action using the inara docker image to generate Open Journal's preprint LaTeX files
https://github.com/xuanxu/preprint-action

Last synced: 6 days ago
JSON representation

GitHub Action using the inara docker image to generate Open Journal's preprint LaTeX files

• Host: GitHub
• URL: https://github.com/xuanxu/preprint-action
• Owner: xuanxu
• License: mit
• Created: 2022-09-12T11:16:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-04T10:54:34.000Z (5 months ago)
• Last Synced: 2024-12-10T01:41:58.574Z (13 days ago)
• Language: Ruby
• Size: 25.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Open Journals :: Preprint

This action looks for a `paper.md` file in the specified repository and uses it to generate a simple LaTeX file suitable to send to preprint archives.

Under the hood it uses the [openjournals/inara action](https://github.com/openjournals/inara) to generate the output file.

## Usage

Usually this action is used from an ongoing review on an Open Journal's repository

### Inputs

The action accepts the following inputs:

- **issue_id**: Required. The review issue id of the submission for the paper.

- **repository_url**: Required. The repository URL of the submission containing the paper file.

- **branch**: Optional. Git branch where the paper is located.

- **journal**: Optional. The journal data to use for the paper. Default value is `joss`.

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

````yaml

on:

  workflow_dispatch:

   inputs:

      issue_id:

        description: 'The issue number of the submission'

jobs:

  preprint:

    runs-on: ubuntu-latest

    steps:

      - name: Generate preprint

        uses: xuanxu/preprint-action@main

        with:

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

          repository_url: http://github.com/${{ github.repository }}

          branch: docs

          journal: joss

```