Max P.
3aee9078e1
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
- Updated `scripts/generate-changelog.sh` and `scripts/install-git-cliff.sh` to use `SCRIPT_DIR` for sourcing utility files. - Ensured paths are resolved relative to the script location, independent of the working directory. - Improved script reliability and portability.
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
.envfile. - Enhanced logging with multiple log levels.
- Support for custom
git-cliffconfigurations.
Usage
Prerequisites
Ensure the following tools are installed:
gitgit-cliffsed
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 forgit-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.