https://github.com/justcoded/dockerize-php-conventional-changelog

Generate a changelog from a git commits history using composer and conventional-commits.
https://github.com/justcoded/dockerize-php-conventional-changelog

conventional-commits docker php php-cli

Last synced: about 1 month ago
JSON representation

Generate a changelog from a git commits history using composer and conventional-commits.

• Host: GitHub
• URL: https://github.com/justcoded/dockerize-php-conventional-changelog
• Owner: justcoded
• Created: 2023-09-19T10:27:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-03T12:37:35.000Z (over 1 year ago)
• Last Synced: 2023-10-04T22:27:54.439Z (about 1 year ago)
• Topics: conventional-commits, docker, php, php-cli
• Language: Dockerfile
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Quick reference

* **Conventional Commits**  

  https://www.conventionalcommits.org/

* **SemVer**  

  https://semver.org/

* **PHP Conventional Changelog**  

  https://github.com/marcocesarato/php-conventional-changelog

# What is Conventional Changelog

This docker image is based on [PHP 8.1 CLI](https://hub.docker.com/_/php) with

additional `composer` and global `marcocesarato/php-conventional-changelog` package

installed inside.

You can run this image directly to generate nice CHANGELOG.md file inside your git

working directory.

This image doesn't suppose to commit/push anything (in opposite that main package supports

these features). Usually in our practice we need to verify generated changelog 

before committing it to the repository, and tags are created from GitHub or BitBucket

user interface.

# How to use this image

## Run a single generator

If you already have `CHANGELOG.md` file and tags and you want to generate next release

notes you can simply run such command:

```bash

$ docker run -it --rm --name conventional-changelog -v "$PWD":/codebase  ghcr.io/justcoded/php-conventional-changelog

```

## Specify additional parameters

In case you want to customize generator parameters and specify config file or 

`--first-release` option, then you should run image as follows:

```bash

$ docker run -it --rm --name conventional-changelog -v "$PWD":/codebase  ghcr.io/justcoded/php-conventional-changelog bash -c "conventional-changelog --first-release" 

```