Contrib.social

Improve upgrade documentation

Open on Drupal.org →
Created on 23 November 2023, 7 months ago

Keep somewhere a changelog summary.

A lot of projects use CHANGELOG.md in the root of the project. But it could also be put in the README.md and the project page on drupal.org.

Reason: I'm running a Drupal 10 instance, I currently have config_filter 2.4.0 and according to "composer outdated" I can go to config_filter 2.6.0. But should I? It's a minor change, and I don't expect anything to break. But some kind of update log would be nice. I'm not even interested in a complete change log, but I am interested in relevant changes (Why would I upgrade from e.g 2.4.0 to 2.5.0, or from 2.5.0 to 2.6.0... what are the benefits?).

✨ Feature request
Status

Closed: works as designed

Version

2.0

Component

Documentation

Created by

sboden

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @sboden
  • Status changed to Closed: works as designed 7 months ago
  • Comment 7 months ago →
    🇨🇭Switzerland bircher 🇨🇿

    Thanks for opening an issue for something you think could be improved.

    However it is too much effort to maintain a second changelog when there is one already as part of each release note → .

    The release notes contain mostly automatic content, but sometimes also some handcrafted information.
    If you want to see the automatic content for the changes spanning between several versions you can use the same tool used to generate the changelog for each version: https://drupal-mrn.dev/

    That said config_filter has been extremely stable and not much has needed to change in the last couple of years.

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024