Opened 3 years ago

Closed 3 years ago

#778 closed task (fixed)

Generate ChangeLog from git log

Reported by: strk Owned by: geos-devel@…
Priority: major Milestone: 3.7.0
Component: Default Version: 3.5.0
Severity: Unassigned Keywords: git
Cc: mloskot

Description

A git2cl tool exists and is packaged on debian, but as the current ChangeLog? format includes revision numbers we'll need to drop that information for the new ChangeLog? (no revision numbers in a git-only repo).

One possibility here is to save the old ChangeLog? files into a subdirectory (doc/changelog?) and start with a fresh one starting from where the old one ends.

Another is to STOP checking the ChangeLog? into the repository but always only generate it at "make dist" time, which may be a bit tricky to pass "make distcheck" (as it sets the sources read-only) but may set us free from future management issues.

This is propedeutic for moving the codebase from SVN to git.

Change History (15)

comment:1 Changed 3 years ago by mloskot

Version: 3.5.0

Another possibility is to stop replicating VCS log in the ChangeLog? and not to include any revision info.

Typically, ChangeLog? is written, by humans for humans, as a chronologically ordered list of notable changes for each version of a project, but not all changes/revisions checked in to the repo. I like http://keepachangelog.com/

comment:2 Changed 3 years ago by strk

The "notable changes" role is taken by the NEWS file.

comment:3 Changed 3 years ago by mloskot

IMHO, it's much of bureaucracy.

comment:4 Changed 3 years ago by strk

So you agree with removing the ChangeLog? file from the repository and only manually edit NEWS file (for human-edited "notable" changes) ?

Then we can automatically generate and include the ChangeLog? into official releases (which are downloaded w/out the whole git history)

comment:5 Changed 3 years ago by mloskot

What do you think to put into the ChangeLog? as revision 'number'?

I rather meant, drop the idea of generating ChangeLog?, rename NEWS to ChangeLog? and let release manager (not individual committers) to update it manually.

comment:6 Changed 3 years ago by strk

No revision numbers, is my proposal. Autogenerated ChangeLog? in the release tarball. Manually edited NEWS (by maintainer-or-committer).

comment:7 Changed 3 years ago by strk

Cc: mloskot added

do you receive a notification now Mat ?

comment:8 Changed 3 years ago by mloskot

Sandro, yes, I have received it.

comment:9 Changed 3 years ago by strk

Milestone: 3.6.03.7.0

Ticket retargeted after milestone closed

comment:11 Changed 3 years ago by strk

r4280 drops ChangeLog? from repo and generates it at "make dist" time (sorry, bad reference in commit log).

To be backported to all other maintained branches.

comment:12 Changed 3 years ago by strk

In 4282:

Remove ChangeLog? from repository.

The file will be created by "make dist" from either git
(if .git exists) or svn (if .svn exists).

Tested with builds from package, from source dir and from
external build dir. Only automake.

See #778

comment:13 Changed 3 years ago by strk

In 4283:

Remove ChangeLog? from repository.

The file will be created by "make dist" from either git
(if .git exists) or svn (if .svn exists).

Tested with builds from package, from source dir and from
external build dir. Only automake.

See #778, backported for 3.5 branch

comment:14 Changed 3 years ago by strk

In 4284:

Remove ChangeLog? from repository.

The file will be created by "make dist" from either git
(if .git exists) or svn (if .svn exists).

Tested with builds from package, from source dir and from
external build dir. Only automake.

See #778, backported for 3.4 branch

comment:15 Changed 3 years ago by strk

Resolution: fixed
Status: newclosed

I think this can be considered closed now

Note: See TracTickets for help on using tickets.