alessandro_podo/git-changelog-generator

Es ist möglich aus einem Git Commit anhand von metadaten ein Changelog zu generieren, dass Leserechte hat

0.0.5 2024-09-16 20:12 UTC

Requires

• php: >=8.2
• symfony/clock: ^7.1
• symfony/console: ^7.1
• symfony/framework-bundle: ^7.1
• symfony/process: ^7.1
• symfony/security-bundle: ^7.1
• symfony/twig-bundle: ^7.1
• symfony/yaml: ^7.1
• webmozart/assert: ^1.11

Requires (Dev)

• ekino/phpstan-banned-code: ^2.0
• friendsofphp/php-cs-fixer: ^3.62
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^1.11
• phpstan/phpstan-symfony: ^1.4
• phpunit/phpunit: ^11.3
• rector/rector: ^1.2
• symfony/dom-crawler: ^7.1
• symplify/phpstan-rules: ^13.0
• tomasvotruba/cognitive-complexity: ^0.2.3

MIT

README

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require alessandro_podo/git-changelog-generator

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    AlessandroPodo\GitChangelogGenerator\GitChangelogGenerator::class => ['all' => true],
];

Step 3: Create Config

# config/packages/git_changelog_generator.yaml

git_changelog_generator:
  validateMapping:
    ROLE_*':
      - <visibility footer>
  scopes:
    - ...

Step 4: Create Controller

Controller

use AlessandroPodo\GitChangelogGenerator\Service\Changelog\Changelog;

#[Route(path: '/changelog')]
public function change(
    Changelog $changelog,
): Response {
   return $this->render('changelog/index.html.twig', ['content'=> $changelog->render()]);
}

TwigTemplate

# extend base Template
{% block body %}
    {{ content|raw }}
{% endblock %}

Einstellungen

# Dateiname kann unten den Optionen angepasst werden. Default ist: plannedChangesFile.yml
composer:
    -
        title: Composer
        description: Composer
        ready: false
        type: refactor

Damit werden geplante Änderungen aufgeführt. Ist das File leer, wird angezeigt, dass keine Änderungen geplant sind. Gibt es das File nicht, wird nichts angezeigt

CommitMessage

• Wenn im Footer title: enthalten ist, dann wird dieser genutzt
• Wenn im Footer description: enthalten ist, dann wird dieser genutzt
• Wenn im Footer visibility:/v: enthalten ist, dann wird dieser genutzt, sonst wird der Default aus dem ConfigFile genutzt