Skip to content

Latest commit

 

History

History
432 lines (233 loc) · 16.5 KB

CHANGELOG.md

File metadata and controls

432 lines (233 loc) · 16.5 KB

Changelog

This file has been auto-generated from the contents of changelog.json

1.0.1

Fix

  • branch named 'main' is not considered as main branch for changes to happen

Links: src diff

1.0.0 (2022-04-21)

Feature

  • drop PHP <7.4 and symfony/process <4.2 support [issues/6]

Links: src diff

0.17.1 (2021-02-24)

Fix

  • bootstrap command throwing an error in every possible use case, rendering the command unusable

Maintenance

  • update CI job to have one job per Composer MAJOR

Links: src diff

0.17.0 (2021-02-14)

Feature

  • add support for Composer 2 [issues/3]

Fix

  • remove 'overview' from output when there is none (in info with brief mode)
  • fix bootstrap command that never worked (error: The 'type' option does not exist.)

Maintenance

  • introduce ready-to-use development environment setup for quicker developer onboarding

Links: src diff

0.16.1 (2021-01-31)

Maintenance

  • root package installation fixes where the dependencies targeted private Packagist index
  • updates to README on output generator types and where to find the templates
  • fix to dev scripts not running as expected on Mac
  • code normalizer script not working as expected

Links: src diff

0.16.0 (2019-09-24)

Feature

  • new command added to allow seamlessly set up the features that the plugin provides: changelog:bootstrap

Fix

  • allow the plugin to be installed as dependency to globally installed package; previously caused every composer call to crash with class declaration conflict
  • allow usage on older Composer version (before plugins could provide new composer commands)

Links: src diff

0.15.6 (2019-07-29)

Fix

  • changelog not properly resolved from Compose package repository when alias pacakges encountered

Links: src diff

0.15.5 (2019-07-19)

Fix

  • anchors in Sphinx output for release change group titles were anonymous instead of being unique to specific release
  • if a sentence in changelog change description started with two-letter word, it was incorrectly converted to '..' (affects Sphinx format)

Links: src diff

0.15.4 (2019-04-22)

Fix

  • class names (like This\That) not rendered correctly on Sphinx output (separators stripped)

Links: src diff

0.15.3 (2019-04-16)

Fix

  • reduced overview added odd extra space in front of a new line when new lines used (blank line in the middle of overview)
  • changelog:info did not work correctly when used on ROOT package
  • certain templates did not render wrapper elements correctly (issue introduced after switching to new, 5.3-compatible output generator)

Maintenance

  • code repetition reduced within command classes

Links: src diff

0.15.2 (2019-04-16)

Fix

  • fix to generate command where it was url-encoding certain characters even when output was not HTML
  • allow the usage of '..' in front of changelog changes-group item when generating output for Sphinx (previously those items were rendered invisible)

Links: src diff

0.15.1 (2019-04-14)

Fix

  • load every class on plugin startup to make sure that there is no version clash when upgrading the plugin (upgrade run would end with using old version's code)

Maintenance

  • switch to Mustache template engine that's referred to on the official Mustache page (it also comes with lower PHP version expectation)
  • lowered PHP version requirement (possible due to dependency switch)
  • added php compatibility check (starting from 5.3) and code static analysis

Links: src diff

0.15.0 (2019-03-20)

Feature

  • added better JSON validation to provide user with proper error messages rather than just obscure 'something is wrong' ones

Links: src diff

0.14.0 (2019-03-12)

Feature

  • allow comment blocks in JSON (anything that starts with underscore) to allow embedded guides or references to schemas to be part of the changelog

Maintenance

  • make sure that the proxy-plugin does not crash due to some dependency not loading properly on startup

Links: src diff

0.13.1 (2019-02-05)

Fix

  • package repository resolver: fuzzy query used when package query not provided (resulting in failure that proposes all packages as potential matches): should have used root package
  • package repository resolver: exact package name match not prioritized over partial match

Links: src diff

0.13.0 (2019-02-05)

Feature

  • added GIT support for diff links and date resolver
  • allow fuzzy package names when generating changelog for sub-repository

Fix

  • potentially confusing anchors for releases in Sphinx changelog format (where releases got anchors like #id1, #id2, etc)
  • upcoming version had DEV marker in it; should be valid version instead (made no sense otherwise when used with --segments, etc)

Links: src diff

0.12.0 (2019-01-30)

Feature

  • allow specifying repository url with changelog:generate command argument --url to provide custom url in cases where no other source for resolving it is available

Maintenance

  • allow the commands that this plugin repository provides to be used on itself
  • added changelog output with MD format output

Links: src diff

0.11.0 (2019-01-30)

Feature

  • add repository from version to version diff links when module has repository reference in composer.json or when one provided via call argument (with optional variable replacement options); Currently only features BitBucket support. See the topic 'Feature: repository links' for more information.
  • add repository versioned source links when module has repository reference in composer.json or when one provided via call argument (with optional variable replacement options); Currently only features BitBucket support. See the topic 'Feature: release dates' for more information.
  • add release date next to the version when repository present and there's a matching tag available for a changelog record.

Fix

  • no extra line before summary when release has no overview
  • yml format error when using summary due to a colon within the value with no wrapping quotes
  • corrupt yml format on full changelog generation where nesting level did not get correctly reset for every release but the first

Links: src diff

0.10.1 (2019-01-28)

Fix

  • the 'overview-reduced' not considered as something that is not a changes group type
  • the value of overview-reduced not composed correctly: some words merged together without whitespace

Links: src diff

0.10.0 (2019-01-24)

Feature

  • --segments argument added for changelog:version to be able to query for the latest MAJOR version from changelog

Links: src diff

0.9.4 (2019-01-17)

Fix

  • slack format to use overview info a bit differently to avoid odd line wrapping: lines are merged, only totally new lines are respected and paragraph separators

Links: src diff

0.9.3 (2018-12-10)

Fix

  • formatting fixes to templates when used for full documentation generation (whitespace missing between certain titles in some cases)
  • version wrapper for TXT changelog template

Links: src diff

0.9.2 (2018-12-03)

Fix

  • minor whitespace issues with Slack changelog release info templates; too many empty lines when overview not present

Links: src diff

0.9.1 (2018-11-30)

Fix

  • whitespace usage in certain formats (sphinx) caused generated documentation to be incorrect
  • summary merged into overview, which made it impossible to properly format summarized version changelog output

Links: src diff

0.9.0 (2018-11-30)

Feature

  • new output format: slack (formatting markup for Slack)

Links: src diff

0.8.0 (2018-11-28)

Feature

  • new output format: txt (no formatting markup)

Fix

  • output format types could not be used with ':info' even when output file was not defined
  • removed excess whitespace from changelog output (for both ':info' and ':generate')
  • undefined array key crash when configuring custom templates for changelog output within the package that owns the changelog

Links: src diff

0.7.0 (2018-10-04)

Feature

  • added .md, .yml and .rst format options for info command
  • sphinx template upgraded to take use of some it's more advanced features (overview decorated and made to stand out more)

Fix

  • the reason for changelog not being valid not shown when running in non-verbose mode, leaving the user wondering what went wrong (now lists all reasons)
  • bug in html output template (list item tag never closed on changelog release listing level)

Links: src diff

0.6.4 (2018-09-02)

Fix

  • removed code that was incompatible with 5.3

Links: src diff

0.6.3 (2018-09-02)

Fix

  • composer run crashes when changelog plugin gets uninstalled while running (when defined under require-dev and running with --no-dev)

Links: src diff

0.6.2 (2018-08-15)

Fix

  • url-decoded branch names not dealt with correctly when provided as branch variables

Links: src diff

0.6.1 (2018-08-15)

Fix

  • treat 'master' and 'default' branches also match with changelog records that don't have branch specified (these branch names CAN still be used on changelog items)
  • changelog:version --upcoming not taking --branch config into account

Links: src diff

0.6.0 (2018-08-15)

Feature

  • support for using changelog-based releases on multiple branches (--branch option added, version command now return version that either has no branch or matches branch)
  • added 'upcoming' support for changelog:info command

Links: src diff

0.5.2 (2018-08-08)

Fix

  • avoid loud crash when changelog file has syntax errors; proper error handling and validation introduced instead

Links: src diff

0.5.1 (2018-08-07)

Fix

  • validation exited with wrong exit code on failure

Links: src diff

0.5.0 (2018-08-07)

Feature

  • added new command to validate the changelog's contents

Links: src diff

0.4.0 (2018-08-07)

Feature

  • format option added for version command
  • upcoming version output added to version command

Fix

  • info command was missing one formatting option
  • improved error management

Links: src diff

0.3.1 (2018-08-06)

Fix

  • brief changelog info mode added overview separator even when there was no overview set

Links: src diff

0.3.0 (2018-08-06)

Feature

  • new command added for acquiring information about specific release: changelog:info
  • allow multi-line contents for 'overview'

Fix

  • template overrides not properly applied (over the ones that ship with the plugin)

Maintenance

  • output templating changed to be more granular to allow same templates to be used for both changelog:info output and for documentation generation

Links: src diff

0.2.0 (2018-08-03)

Feature

  • new command added for reporting latest valid version tag from changelog: changelog:version

Links: src diff

0.1.2 (2018-08-02)

Fix

  • wrong path resolved for root package (causing event handler to fail and no docs to be generated)
  • generate command failure printed out whole exception rather than just it's message

Links: src diff

0.1.1 (2018-08-02)

Fix

  • fixed a typo in plugin's event observer name (changelog bot generated when package installed as root package)

Links: src diff

0.1.0 (2018-08-02)

Feature

  • allow Sphinx documentation file to be generated from changelog contents ('changelog:generate' command)
  • generate changelog for root package on install/update

Links: src diff