Problem/Motivation

CHANGELOG.txt is almost empty, except for these two lines:

Nodeaccess 7.x-1.x
===================

Proposed resolution

Option 1:
Add changelog info with the release notes, like this: https://git.drupalcode.org/project/metatag/-/blob/8.x-1.x/CHANGELOG.txt
(I would include the notes from beta1-beta4, 1.0, 1.1 -- easy to copy/paste from the release pages.)

Option 2:
Point people to the list of releases, like this: https://git.drupalcode.org/project/admin_toolbar/-/blob/8.x-2.x/CHANGELO...

Option 3:
Remove CHANGELOG.txt

Remaining tasks

Do it.

CommentFileSizeAuthor
#8 3244977-8.patch182 bytesjungle

Issue fork nodeaccess-3244977

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

alisonjo315 created an issue. See original summary.

alison’s picture

alison
she/her
commented
Issue summary: View changes

IS: Add three options.

-------
Personally, I like having a CHANGELOG.txt file, because you get to see what's changed across multiple releases in one place (not that I ever, ever fall more than one release behind). But, I'm open to being convinced to go with option 2 or 3 😊

alisonjo315 opened merge request !3

alison’s picture

alison
she/her
commented

Went for "Option 1" (issue fork + MR), because I'm already in here today, and who knows how soon I'll be back.

Full disclosure: I haven't done the "issue fork" > "merge request" process yet -- I mean, I've done it on GitHub, but not Drupal GitLab. Let's all cross our fingers and think happy thoughts 🤞

alison’s picture

alison
she/her
commented
Status: Active » Needs review
jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
Version: 8.x-1.x-dev » 2.0.x-dev

Hi, @alison

  • I would vote for option 3, I checked a few frequently used modules and found most of them have no CHANGELOG.txt(or .md) file shipped with the module. Eg. commerce, profile, token, webform, paragraphs.
  • For option 1, jquery_ui, search_api are doing the same
  • For option 2, admin_toolbar is the only one I found.

The order of the 3 options I would vote for is 3 > 2 > 1, the option 1 is the last.

Another reason I am voting for 3 is that we may forget to keep it up-to-date and we did forget.

I read release notes, and care hook_update_N implementations. I rarely read CHANGELOG, -- especially, git-log-messages-like CHANGELOG.

jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
Parent issue: » #3317693: [Meta] 2.0.x branch: Working toward a stable release
jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
StatusFileSize
new 3244977-8.patch182 bytes

Remove it?

jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
Title: Update CHANGELOG.txt » Remove CHANGELOG.txt
jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
Status: Needs review » Reviewed & tested by the community

Sorry, @alison I would like to go ahead

  • jungle committed d372454 on 2.0.x 
    Issue #3244977 by alison, jungle: Remove CHANGELOG.txt
jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
Status: Reviewed & tested by the community » Fixed
alison’s picture

alison
she/her
commented

No sorry necessary at all -- thank you!!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.