Installation

As a Forgejo action

Reference the action from a workflow step. Pinning the version is recommended; use a tag such as @1.9.0 or the rolling @latest.

name: Release

on:
  push:
    tags:
      - '*'

jobs:
  changelog:
    runs-on: ubuntu-latest
    steps:
      - name: Generate changelog
        uses: https://vc.maxkaya.com/maxpeterkaya/changelog@latest
        with:
          server_url: https://vc.maxkaya.com
          repository: ${{ github.repository }}
          token: ${{ secrets.PAT }}

Token requirements

The token must be a personal access token (or other token) with:

• read access to the repository, its commits, and its tags;
• write access to releases and tags.

Pass it through a secret. The action uses it both for the API and for pushing changelog commits when write_to_file or write_per_tag is enabled.

As a container image

Every release publishes an image to vc.maxkaya.com/maxpeterkaya/changelog. It is configured entirely through environment variables, so it works in any scheduler that can set env vars.

docker run --rm \
  -e INPUT_SERVER_URL=https://vc.maxkaya.com \
  -e INPUT_REPOSITORY=owner/repo \
  -e INPUT_TOKEN=... \
  vc.maxkaya.com/maxpeterkaya/changelog:latest

When running outside Gitea/Forgejo Actions, set GITHUB_OUTPUT if you want outputs written to a file; otherwise outputs are printed to stdout.

As a prebuilt binary

Release assets include a standalone changelog binary for Linux, macOS, FreeBSD, NetBSD, and OpenBSD on amd64, arm64, armv6, and armv7. Download the binary for your platform from the Releases page of this repository.

Where to go next

• Inputs Reference
• Tag Ranges and Rollup
• Styles and LLM Providers

---

Home · Inputs Reference · Outputs and Commit Groups · Tag Ranges and Rollup · Writing Changelogs to the Repository · Styles and LLM Providers · Troubleshooting