xuanxu / retraction-action

GitHub Action to generate Open Journal's retraction notices

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Open Journals :: Retraction

GitHub Action to generate Open Journal's retraction notices

Usage

This action is meant to be run manually

Inputs

The action requires the following inputs:

  • issue_id: Required. The review issue id for the paper to be retracted
  • retraction_notice_url: Required. URL for the markdown file of the retraction notice
  • journal: Optional. The journal where the retracted paper is published. Default is 'joss'.
  • papers_repo: Optional. The repository for the published papers. Default is 'openjournals/joss-papers'
  • papers_repo_main_branch: Optional. The name of the repo's main branch to issue the pull request against
  • branch_prefix: Optional. The prefix to add to the name of all branches
  • github_bot_token: Required in final mode. The GitHub access token to be used to upload files
  • journal_secret: Required in final mode. The access token to be used to deposit the paper
  • crossref_username: Required in final mode. Crossref username doing the deposit
  • crossref_password: Required in final mode. Crossref password
  • crossref_mode: Optional. Use test (if value is 'test') or production crossref calls
  • mode: Optional. Set the compiled retraction notice as a draft or as a final published paper. Posible values are 'draft' or 'final'.

About

GitHub Action to generate Open Journal's retraction notices

License:MIT License


Languages

Language:Ruby 100.0%