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

GitHub Action to generate Open Journal's retraction notices
https://github.com/xuanxu/retraction-action

Last synced: 7 days ago
JSON representation

GitHub Action to generate Open Journal's retraction notices

• Host: GitHub
• URL: https://github.com/xuanxu/retraction-action
• Owner: xuanxu
• License: mit
• Created: 2023-07-27T10:40:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-25T09:53:30.000Z (5 months ago)
• Last Synced: 2024-12-10T02:07:07.256Z (13 days ago)
• Language: Ruby
• Size: 53.7 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 :: 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'.