hana-developer-cli-tool-example: Instructions file for GitHub Copilot

Release Management Guidelines

Use this guide when preparing releases, updating the changelog, or publishing new versions of the hana-cli tool.

Scope and Purpose

This guide applies to:

• CHANGELOG.json - Structured changelog entries
• package.json - Version number updates
• scripts/CHANGELOG.js - Changelog generation script
• Release preparation and npm publishing process

Version Numbering Convention

Primary Package (hana-cli)

Format: MAJOR.YYYYMM.PATCH

Examples:

• 4.202602.0 - Version 4, released February 2026, patch 0
• 3.202601.0 - Version 3, released January 2026, patch 0
• 3.202511.0 - Version 3, released November 2025, patch 0

Components:

• MAJOR - Major version number (incremented for breaking changes or significant milestones)
• YYYYMM - Year and month of release (e.g., 202602 = February 2026)
• PATCH - Patch number within the month (typically 0 for first release, 1+ for hotfixes)

MCP Server Package

Format: MINOR.YYYYMM.PATCH

Example: 1.202602.0

Location: mcp-server/package.json

Note: MCP server versioning follows same date-based pattern but with lower major version number since it's a newer component.

Documentation Package

Format: Standard semantic versioning MAJOR.MINOR.PATCH

Example: 1.0.0

Location: docs/package.json

Note: Documentation version is independent and follows standard semver.

CHANGELOG.json Structure

File Format

Location: Root directory CHANGELOG.json

Structure: Array of release objects

[
  {
    "date": "YYYY-MM-DD",
    "version": "MAJOR.YYYYMM.PATCH",
    "Changed": [
      "Description of change 1",
      "Description of change 2",
      "..."
    ]
  },
  {
    "date": "YYYY-MM-DD",
    "version": "MAJOR.YYYYMM.PATCH",
    "Added": [
      "New feature 1",
      "New feature 2"
    ],
    "Fixed": [
      "Bug fix 1"
    ],
    "Changed": [
      "Changes 1"
    ],
    "Deprecated": [
      "Deprecated item"
    ],
    "Removed": [
      "Removed feature"
    ],
    "Security": [
      "Security fix"
    ]
  }
]