1 Inputs Reference
maxpeterkaya edited this page 2026-09-16 10:10:52 -04:00

Inputs Reference

Every input is optional except server_url, repository, and token. owner may be omitted when repository already uses the owner/name form.

Input Required Default Description
server_url yes — Forgejo instance URL, for example https://vc.maxkaya.com.
repository yes — Repository in owner/name form.
owner conditional — Repository owner. May be omitted when repository is owner/name.
token yes — Token with read access to the repository and write access to releases and tags.
tag no newest tag Tag to generate the changelog for.
to_tag no newest tag End tag of the comparison range.
from_tag no previous tag Start tag of the comparison range.
rollup no false Widen the comparison range by semantic version. See Tag Ranges and Rollup.
debug no false Enable debug logging.
style no conventional Output style: conventional, detailed, or summary. See Styles and LLM Providers.
write_to_file no false Write the changelog to CHANGELOG.md and commit/push it.
write_per_tag no false Write the changelog to changelogs/<tag>.md and commit/push it.
branch no current branch Branch to push changelog commits to.
ollama_enabled no false Rewrite entries with Ollama.
ollama_url no — Ollama instance URL, for example http://localhost:11434.
ollama_key no — Ollama API key.
ollama_model no — Ollama model to use.
openai_enabled no false Rewrite entries with an OpenAI API-compatible provider. Takes precedence over Ollama.
openai_url no — Base URL of the provider, for example https://api.openai.com/v1.
openai_key no — API key. Optional for local servers without authentication.
openai_model no — Model to use.

Without tag, to_tag, and from_tag, the changelog is built from the two most recent tags.

Environment variables

When you run the container or binary directly, the same settings are read from environment variables. Use the INPUT_ prefix:

Action input Environment variable
server_url INPUT_SERVER_URL (falls back to GITHUB_SERVER_URL)
repository INPUT_REPOSITORY (falls back to GITHUB_REPOSITORY)
owner INPUT_OWNER (falls back to GITHUB_REPOSITORY_OWNER)
token INPUT_TOKEN (falls back to GITHUB_TOKEN)
tag INPUT_TAG
to_tag INPUT_TO_TAG
from_tag INPUT_FROM_TAG
rollup INPUT_ROLLUP
debug INPUT_DEBUG
style INPUT_STYLE
write_to_file INPUT_WRITE_TO_FILE
write_per_tag INPUT_WRITE_PER_TAG
branch INPUT_BRANCH
ollama_enabled INPUT_OLLAMA_ENABLED
ollama_url INPUT_OLLAMA_URL
ollama_key INPUT_OLLAMA_KEY
ollama_model INPUT_OLLAMA_MODEL
openai_enabled INPUT_OPENAI_ENABLED
openai_url INPUT_OPENAI_URL
openai_key INPUT_OPENAI_KEY
openai_model INPUT_OPENAI_MODEL

When running outside Actions, GITHUB_OUTPUT is optional. If it is not set, outputs are printed to stdout instead. See Outputs and Commit Groups.


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