README

Usage

This component forms the foundation for both Drupal and PHP Library conventions. It offers core functionality that the derived components expand upon. To use these conventions in your project, pick the derived component that fits your needs. For more details, visit the following pages:

• PHP Library: https://github.com/openeuropa/code-review-library
• Drupal project: https://github.com/openeuropa/code-review-drupal

Upgrade from 2.x to 3.x

This component is no longer used as the final version for any project. If you're upgrading to the 3.x version, please refer to the transition section in the relevant derived component’s documentation:

• PHP Library
• Drupal project

Development

Installation

The library provides a docker-compose configuration file to be used for development.

Requirements:

• Docker
• Docker Compose

Configuration

To start, run:

docker-compose up -d
docker-compose exec web composer install

Changelog

The changelog is generated using a local docker installation which installs muccg/docker-github-changelog-generator

This reads the Github API for the required repository and writes the CHANGELOG.md to the root of the repository.

Prerequisites

• Local Docker machine running (not detached).
• A Github Access Token should be generated and exported (or written to ~/.gitconfig) as CHANGELOG_GITHUB_TOKEN=<YOUR TOKEN HERE>

Before tagging a new release export the following:

export CHANGELOG_GITHUB_TOKEN=<YOUR TOKEN HERE>
export CHANGELOG_FUTURE_RELEASE=0.1.0

The changelog can then be generated by running:

composer run-script changelog