releaseit

ReleaseIt!

Utility for generating and publishing changelogs to different destinations.

Inspired by mikepenz/release-changelog-builder-action

All application options

Application Options:
      --dbg                                    turn on debug mode [$DEBUG]

Help Options:
  -h, --help                                   Show this help message

[release command options]
          --tag=                               tag to be released [$TAG]

    engine:
          --engine.type=[github]               type of the repository engine [$ENGINE_TYPE]

    repo:
          --engine.github.repo.owner=          owner of the repository [$ENGINE_GITHUB_REPO_OWNER]
          --engine.github.repo.name=           name of the repository [$ENGINE_GITHUB_REPO_NAME]

    basic_auth:
          --engine.github.basic_auth.username= username for basic auth [$ENGINE_GITHUB_BASIC_AUTH_USERNAME]
          --engine.github.basic_auth.password= password for basic auth [$ENGINE_GITHUB_BASIC_AUTH_PASSWORD]

    telegram:
          --notify.telegram.chat_id=           id of the chat, where the release notes will be sent [$NOTIFY_TELEGRAM_CHAT_ID]
          --notify.telegram.token=             bot token [$NOTIFY_TELEGRAM_TOKEN]
          --notify.telegram.web_page_preview   request telegram to preview for web links [$NOTIFY_TELEGRAM_WEB_PAGE_PREVIEW]
          --notify.telegram.conf_location=     location to the config file [$NOTIFY_TELEGRAM_CONF_LOCATION]

    github:
          --notify.github.release_name_tmpl=   template for release name [$NOTIFY_GITHUB_RELEASE_NAME_TMPL]
          --notify.github.conf_location=       location to the config file [$NOTIFY_GITHUB_CONF_LOCATION]

    repo:
          --notify.github.repo.owner=          owner of the repository [$NOTIFY_GITHUB_REPO_OWNER]
          --notify.github.repo.name=           name of the repository [$NOTIFY_GITHUB_REPO_NAME]

    basic_auth:
          --notify.github.basic_auth.username= username for basic auth [$NOTIFY_GITHUB_BASIC_AUTH_USERNAME]
          --notify.github.basic_auth.password= password for basic auth [$NOTIFY_GITHUB_BASIC_AUTH_PASSWORD]

    stdout:
          --notify.stdout.conf_location=       location to the config file [$NOTIFY_STDOUT_CONF_LOCATION]

Release notes builder configuration

Example release notes builder configuration

categories:
  - title: "## 🚀 Features"
    labels:
      - "feature"
  - title: "## 🐛 Fixes"
    labels:
      - "fix"
  - title: "## 🧰 Maintenance"
    labels:
      - "maintenance"
unused_title: "## ❓ Unlabeled"
ignore_labels:
  - "ignore"
sort_field: "-number"
template: |
  Project: Example release config
  Development area: Backend
  Version {{.Tag}}
  Date: {{.Date.Format "Jan 02, 2006 15:04:05 UTC"}}
  {{if not .Categories}}- No changes{{end}}{{range .Categories}}{{.Title}}
  {{range .PRs}}- {{.Title}} (#{{.Number}}) by @{{.Author}}
  {{end}}{{end}}
empty_template: "- no changes"

Template variables for release notes builder

The golang's text/template package is used for executing template for release notes.

(Github) Template variables for release title