Max P. 8e048a1a89
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
refactor: remove config.env and integrate settings into scripts
- Deleted `config.env` as all values are now directly integrated into the scripts.
- Updated `scripts/generate-changelog.sh` to replace remaining `echo` commands with `log_info` and `log_error`.
- Ensured all scripts are self-contained and consistent in their logging and configuration handling.
2025-07-02 13:16:18 +02:00
2025-06-27 22:48:36 +02:00

Auto Debian Package Changelog Generation

This project provides a streamlined solution for generating Debian-compatible changelogs using git-cliff.

Features

  • Modularized scripts for better maintainability.
  • Centralized configuration via .env file.
  • Enhanced logging with multiple log levels.
  • Support for custom git-cliff configurations.

Usage

Prerequisites

Ensure the following tools are installed:

  • git
  • git-cliff
  • sed

Running the Script Locally

To generate a changelog locally, use the run.sh script:

curl -sL https://https://git.0xmax42.io/actions/deb-changelog-action/raw/branch/main/run.sh | bash -s -- \
         --version v0 \
         --tag v2.9.1 \
         --package_name mypkg \
         --author_name "Max Mustermann" \
         --author_email max@example.com \
         [--output_file debian/changelog] \
         [--cliff_config path/to/cliff.toml]

Configuration

The config.env file contains default configurations:

  • REPO_URL: Repository URL for cloning.
  • OUTPUT_FILE: Default output file for the changelog.
  • CLIFF_CONFIG: Default configuration file for git-cliff.

Logging

Logs are categorized into three levels:

  • INFO: General information.
  • WARN: Warnings about potential issues.
  • ERROR: Critical errors that require attention.

Testing

Unit tests for the scripts can be added using bats.

Contributing

Feel free to submit issues or pull requests to improve the project.

License

This project is licensed under the MIT License.

Description
No description provided
Readme 125 KiB
2025-07-02 13:59:16 +02:00
Languages
Shell 100%