action.yml

name: 'DevtoGitHub'
description: 'Save your Dev.to articles with all the necessary information on GitHub'
author: 'Anmol Baranwal <anmolbaranwal119@gmail.com>'
inputs:
  devApiKey:
    description: 'Dev API key (required)'
    required: true
  gh-token:
    description: 'The GitHub token for authentication.'
    default: ${{ github.token }}
    required: false
  outputDir:
    description: 'The output directory for creating markdown files'
    default: 'articles'
    required: false
  outputDirReading:
    description: 'The output directory for saving reading list'
    default: ''
    required: false
  readingList:
    description: 'To create a reading list from DEV.'
    default: 'false'
    required: false
  readTime:
    description: 'Reading time for articles in reading list'
    default: 'false'
    required: false
  excludeTags:
    description: 'To filter the reading list to avoid from this tag.'
    default: ''
    required: false
  mustIncludeTags:
    description: 'To create a reading list from DEV to include this tag at all costs.'
    default: ''
    required: false
  synchronizeReadingList:
    description: 'To synchronize reading list with dev.to'
    default: 'false'
    required: false
  saveArticles:
    description: 'To save all the articles with all the necessary information.'
    default: 'true'
    required: false
  saveArticlesReadme:
    description: 'To create a list of saved articles linked with their respective file in the readme.'
    default: 'false'
    required: false
  branch:
    description: 'The git branch to use'
    required: false
    default: 'main'
  conventionalCommits:
    description: 'Use conventional commit message standards'
    required: false
    default: 'true'
runs:
  using: 'node20'
  main: 'dist/index.js'
branding:
  icon: 'save'
  color: 'gray-dark'