Skip to content
This repository has been archived by the owner on Sep 20, 2021. It is now read-only.

Update the devtools:snapshot command to use structured commit information when generating changelog. #49

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

shulard
Copy link
Contributor

@shulard shulard commented Jan 23, 2018

With the RFC hoaproject/Central#61 we introduce structured commits with the pattern : type(scope) title.

This PR update the changelog step to use this new information when generating the CHANGELOG.md file.

At the moment, all the commits are kept in the resulting file. The non structured ones are stored inside a specific "Commits" sections.

Here an example with the latest hoaproject/Websocket tag :

3.18.01.23

Quality

Composer

  • Use dev-master dependencies. (Ivan Enderlin, 2018-01-23T10:42:02+01:00)
  • add PHP version requirement (Alexis von Glasow, 2017-08-04T13:48:47+02:00)

PHP

  • Update to PHP 7. (Ivan Enderlin, 2017-11-10T10:30:28+01:00)
  • Update to PHP 7. (Ivan Enderlin, 2017-11-10T10:13:42+01:00)
  • Update to PHP 7. (Ivan Enderlin, 2017-11-08T15:55:02+01:00)
  • Fix composer. (Ivan Enderlin, 2017-11-08T15:35:39+01:00)
  • Update to PHP 7. (Ivan Enderlin, 2017-11-08T15:33:56+01:00)

CI

  • Drop HHVM support. (Stéphane HULARD, 2017-07-07T11:51:42+02:00)

Commits

  • Connection: Add close-before event. (Metalaka, 2017-03-30T21:37:26+02:00)
  • Fire close event before closing and on error (jmdevince, 2016-04-28T15:15:33-05:00)
  • Merge branch 'incoming' into issue_58 (Ivan Enderlin, 2017-03-24T15:18:21+01:00)
  • Connection: If a normal close fails, no error. (Ivan Enderlin, 2016-08-04T08:32:03+02:00)
  • Connection: Ensure disconnection on closing. (Ivan Enderlin, 2016-08-04T08:29:50+02:00)

Copy link
Member

@Pierozi Pierozi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise everything looks great 👍

Bin/Snapshot.php Outdated Show resolved Hide resolved
Copy link
Member

@Hywan Hywan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent patch! I've few questions thought, but thanks for doing this, this is very precious!

Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Copy link
Member

@Hywan Hywan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost done! Please, review CS too, and we are good :-).

Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
Bin/Snapshot.php Outdated Show resolved Hide resolved
@shulard shulard force-pushed the feature/changelog-generator branch from f9f5d8a to 6208cf1 Compare February 5, 2018 09:48
Bin/Snapshot.php Outdated Show resolved Hide resolved
@shulard shulard force-pushed the feature/changelog-generator branch from 6208cf1 to c792940 Compare February 5, 2018 10:01
Based on the commit structure : `type(scope) title`

We can generate a more useful changelog.
This option `-w` can be used to follow the keepachangelog.com guidelines by exporting only the most important informations from the commit history...
@shulard
Copy link
Contributor Author

shulard commented Feb 5, 2018

Hello,

I've updated the hoaproject/Literature#32 PR with all the defined commit types. I think we are almost good now 😄.

I've just one question about the "First snapshot" changelog. It's generated when the tag list is empty. Actually, the typed commit logic is not applied in that case, is that still on ?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

Successfully merging this pull request may close these issues.

3 participants