action.yml

---
name: Historian
description: Collects changes between two revisions
author: Memrise
inputs:
  token:
    description: GitHub API token, used for getting the list of commits
    required: true
    default: ${{ github.token }}
  since:
    description: |
      Commit-ish to get changes since.

      Defaults to the most recent tag, or the one before that if `until` points at the same commit.
  until:
    description: Commit-ish to get changes until (defaults to HEAD)
    default: HEAD
  chronological:
    description: Output changes in chronological order
    default: true
  slack channel:
    description: Channel ID to include in the Slack message payload
    default: ""
  slack template:
    description: |
      Message template to be used for line above the Slack output.

      Supports Markdown and makes the following variables available:

      - date
      - since.full
      - since.short
      - time
      - timeNoSeconds
      - until.full
      - until.short

      Date and times are the current time in UTC.

      Default: *Changes from {since.short} to {until.short}*
    default: '*Changes from {since.short} to {until.short}*'
outputs:
  plain-text:
    description: Changes listed in a plain-text format
  markdown:
    description: Changes listed in Markdown format
  slack:
    description: Changes prepared in a Slack-payload friendly format
runs:
  using: node20
  main: dist/index.js