Skip to content
HALOWERK

Codewerk

release notes gen

Parses commits and squash-merged PR titles per Conventional Commits 1.0.0, merges a commit with the PR it references ("(#12)"), drops exact duplicates and groups entries into the sections of the conventionalcommits preset (Features, Bug Fixes, Performance Improvements, Reverts, Documentation, .), with a leading BREAKING CHANGES section built from "!" headers and BREAKING CHANGE footers. Optional repository URL (GitHub or GitLab) adds commit, PR and compare links. By default feat, fix, perf.

POST https://code.halowerk.com/v1/release-notes-gen

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
versionstringYesVersion being released, e.g. 1.3.0.
previous_versionstringNoPrevious version for the compare link.
datestringNoRelease date (YYYY-MM-DD).
commitsarrayNoCommits since the previous release.
pull_requestsarrayNoMerged pull requests (number and title).
repo_urlstringNoRepository web URL (GitHub or GitLab) for links.
tag_prefixstringNoPrefix of release tags for compare links.
include_typesSee schemaNoTypes to show; default feat, fix, perf, revert; "all" shows every type.
include_otherbooleanNoList non-conventional entries under "Other Changes".
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "version"
  ],
  "properties": {
    "version": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "Version being released, e.g. 1.3.0."
    },
    "previous_version": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "Previous version for the compare link."
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "Release date (YYYY-MM-DD)."
    },
    "commits": {
      "type": "array",
      "maxItems": 1000,
      "items": {
        "anyOf": [
          {
            "type": "string",
            "minLength": 1,
            "maxLength": 20000
          },
          {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "message"
            ],
            "properties": {
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 20000,
                "description": "Full commit message (header, body, footers)."
              },
              "hash": {
                "type": "string",
                "pattern": "^[0-9a-fA-F]{7,64}$",
                "description": "Commit hash (optional, used for links)."
              }
            }
          }
        ]
      },
      "default": [],
      "description": "Commits since the previous release."
    },
    "pull_requests": {
      "type": "array",
      "maxItems": 500,
      "default": [],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "number",
          "title"
        ],
        "properties": {
          "number": {
            "type": "integer",
            "minimum": 1
          },
          "title": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          }
        }
      },
      "description": "Merged pull requests (number and title)."
    },
    "repo_url": {
      "type": "string",
      "maxLength": 300,
      "pattern": "^https://[^\\s/]+/[^\\s]+$",
      "description": "Repository web URL (GitHub or GitLab) for links."
    },
    "tag_prefix": {
      "type": "string",
      "maxLength": 20,
      "default": "v",
      "description": "Prefix of release tags for compare links."
    },
    "include_types": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "all"
          ]
        },
        {
          "type": "array",
          "maxItems": 20,
          "items": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9-]{0,30}$"
          }
        }
      ],
      "description": "Types to show; default feat, fix, perf, revert; \"all\" shows every type."
    },
    "include_other": {
      "type": "boolean",
      "default": false,
      "description": "List non-conventional entries under \"Other Changes\"."
    }
  }
}

Open original schema

Published input example

{
  "version": "1.3.0",
  "previous_version": "1.2.0",
  "date": "2026-11-01",
  "commits": [
    "feat(api): add catalogue search",
    "fix: handle an empty catalogue"
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’