action.yml

name: 'Build Pelican for GitHub Pages'
description: 'A simple GitHub Action for producing Pelican build artifacts compatible with GitHub Pages'
author: 'GitHub'
inputs:
  source:
    description: 'Directory where the content files reside.'
    required: false
    default: content
  destination:
    description: 'Output directory of the build. Although it can be nested inside the source, it cannot be the same as the source directory.'
    required: false
    default: ./_site
  configfile:
    description: 'override the default `pelicanconf.py` config file'
    required: false
    default: pelicanconf.py
  theme:
    description: 'setup the theme folder with package.json file, is required if you need install node modules'
    required: false
  build_revision:
    description: 'The SHA-1 of the git commit for which the build is running. Default to GITHUB_SHA.'
    required: false
    default: ${{ github.sha }}
  verbose:
    description: 'Verbose output'
    required: false
    default: true
  token:
    description: 'GitHub token'
    required: true
    default: ${{ github.token }}
runs:
  using: 'docker'
  image: 'Dockerfile'