Compare commits
No commits in common. "1ad1e9810cfed8d790d02d257fe66ba8dbf106ff" and "cd691a32869ca3ab8e03c868ab0afbdd3dfb9e56" have entirely different histories.
1ad1e9810c
...
cd691a3286
@ -1,89 +1,77 @@
|
||||
---
|
||||
# yaml-language-server: $schema=./changelog-schema.yaml
|
||||
project:
|
||||
name: App::Changeman
|
||||
homepage: https://git.babyl.ca/yanick/App-Changelord
|
||||
change_types:
|
||||
- feat:
|
||||
title: Features
|
||||
level: minor
|
||||
- fix:
|
||||
title: Bug fixes
|
||||
level: patch
|
||||
releases:
|
||||
- version: v3.0.2
|
||||
date: 2022-06-17
|
||||
changes: ~
|
||||
- version: v3.0.1
|
||||
date: 2022-06-17
|
||||
changes: ~
|
||||
- version: v3.0.0
|
||||
date: 2022-06-17
|
||||
changes: ~
|
||||
- version: v2.0.0
|
||||
date: 2022-06-17
|
||||
changes: ~
|
||||
- version: v1.2.3
|
||||
date: 2022-01-02
|
||||
changes:
|
||||
- desc: doing the thing
|
||||
type: feat
|
||||
- type: feat
|
||||
desc: doing the thing
|
||||
- |
|
||||
## [2.0.0](https://github.com/yanick/json-schema-shorthand/compare/v1.0.0...v2.0.0) (2020-08-24)
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* things should continue to work as normal, but since to
|
||||
typescript is kinda of a big deal, I'm taking no chance.
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
|
||||
* move project to typescript ([ca3429d](https://github.com/yanick/json-schema-shorthand/commit/ca3429db04ebc183d2b5c000e8d3d2b297a1e001))
|
||||
|
||||
|
||||
## [1.0.0](https://github.com/yanick/json-schema-shorthand/compare/v0.3.2...v1.0.0) (2020-07-30)
|
||||
|
||||
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
|
||||
* add allOf, anyOf, oneOf, not shorthands ([b47ee27](https://github.com/yanick/json-schema-shorthand/commit/b47ee27671a4861756a74f4ad6b0dc10d10f1a3c))
|
||||
|
||||
|
||||
### [0.3.2](https://github.com/yanick/json-schema-shorthand/compare/v0.3.1...v0.3.2) (2020-01-31)
|
||||
|
||||
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
|
||||
* remove shrinkwrap.yaml from repo ([baf6ca5](https://github.com/yanick/json-schema-shorthand/commit/baf6ca5c27f9f7723afa48796da0627160579839))
|
||||
|
||||
|
||||
## 0.3.1 (https://github.com/yanick/json-schema-shorthand/compare/v0.3.0...v0.3.1) (2020-01-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
|
||||
* bump dependency versions to latest (685e13e (https://github.com/yanick/json-schema-shorthand/commit/685e13eba976fda5ba956a105ac2fb039e232860))
|
||||
|
||||
|
||||
## v0.3.0 2018-02-14
|
||||
|
||||
|
||||
## Improvements
|
||||
* New shortcut: '$foo' expands to be `$ref: foo`.
|
||||
* New 'range' shortcut.
|
||||
* New shortcut functions for types `object`, `array`, `number`,
|
||||
`integer`, and `string`.
|
||||
* Add `add_definition` helper function.
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
* `shorthand()` deals gracefully with `null` argument.
|
||||
|
||||
|
||||
|
||||
|
||||
## 0.2.0 2017-01-03
|
||||
* Properties can be made required via a '!' suffix.
|
||||
* Drop Mocha and Chai for TAP for testing.
|
||||
- version: 0.1.0
|
||||
date: 2016-08-01
|
||||
|
||||
- date: 2016-08-01
|
||||
version: 0.1.0
|
||||
changes:
|
||||
- "Recurse down 'allOf', 'oneOf', 'anyOf', 'not'."
|
||||
- Recurse down 'allOf', 'oneOf', 'anyOf', 'not'.
|
||||
- Add 'install' and 'synopsis' sections in doc.
|
||||
- version: 0.0.1
|
||||
date: 2016-07-31
|
||||
|
||||
- date: 2016-07-31
|
||||
version: 0.0.1
|
||||
changes:
|
||||
- Initial release
|
||||
change_types:
|
||||
- feat:
|
||||
level: minor
|
||||
title: Features
|
||||
keywords: []
|
||||
- fix:
|
||||
level: patch
|
||||
title: Bug fixes
|
||||
keywords: []
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
package App::Changelord;
|
||||
|
||||
# version next latest
|
||||
|
||||
use 5.36.0;
|
||||
|
||||
use Moo;
|
||||
@ -10,8 +8,6 @@ use YAML;
|
||||
|
||||
use List::AllUtils qw/ pairmap partition_by /;
|
||||
|
||||
use App::Changelord::Role::ChangeTypes;
|
||||
|
||||
option source => (
|
||||
is => 'ro',
|
||||
format => 's',
|
||||
@ -19,21 +15,138 @@ option source => (
|
||||
default => 'CHANGELOG.yml',
|
||||
);
|
||||
|
||||
has changelog => ( is => 'lazy' );
|
||||
has changelog => (
|
||||
lazy => 1,
|
||||
is => 'ro',
|
||||
default => sub($self) {
|
||||
return YAML::LoadFile($self->source)
|
||||
}
|
||||
);
|
||||
|
||||
has change_types => (
|
||||
is => 'ro',
|
||||
default => sub($self) {
|
||||
return [
|
||||
{ title => 'Features' , level => 'minor', keywords => [ 'feat' ] } ,
|
||||
{ title => 'Bug fixes' , level => 'patch', keywords => [ 'fix' ] },
|
||||
]
|
||||
}
|
||||
);
|
||||
|
||||
sub render_header($self) {
|
||||
|
||||
my $output = "# Changelog";
|
||||
|
||||
my $name = $self->changelog->{project}{name};
|
||||
|
||||
my %links = ();
|
||||
|
||||
if( $self->changelog->{project}{homepage} ) {
|
||||
$name = "[$name][homepage]";
|
||||
$links{homepage} = $self->changelog->{project}{homepage};
|
||||
}
|
||||
|
||||
$output .= " for $name" if $name;
|
||||
|
||||
if(%links) {
|
||||
$output .= "\n\n";
|
||||
$output .= $self->render_refs(%links);
|
||||
}
|
||||
|
||||
$output .= "\n\n";
|
||||
|
||||
sub _build_changelog($self) {
|
||||
return YAML::LoadFile($self->source)
|
||||
}
|
||||
|
||||
with 'App::Changelord::Role::ChangeTypes';
|
||||
with 'App::Changelord::Role::Render';
|
||||
sub render_refs($self,%links) {
|
||||
my $output = '';
|
||||
|
||||
for my $ref ( sort keys %links ) {
|
||||
$output .= " [$ref]: $links{$ref}\n"
|
||||
}
|
||||
|
||||
return $output . "\n";
|
||||
}
|
||||
|
||||
sub as_markdown($self) {
|
||||
my $changelog = $self->changelog;
|
||||
|
||||
my $output = $self->render_header;
|
||||
|
||||
my $n = 0;
|
||||
$output .= join "\n", map { $self->render_release($_, $n++) } $changelog->{releases}->@*;
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
sub render_release($self, $release, $n=0) {
|
||||
|
||||
# it's a string? Okay then!
|
||||
return $release unless ref $release;
|
||||
|
||||
my $version = $release->{version} || ( $n ? '???' : 'NEXT' );
|
||||
my $date = $release->{date};
|
||||
|
||||
my $output = '';
|
||||
|
||||
$output .= "## $version";
|
||||
$output .= ", $date" if $date;
|
||||
|
||||
$output .= "\n";
|
||||
|
||||
if( $release->{changes} ) {
|
||||
my @changes = map { ref ? $_ : { desc => $_ } } $release->{changes}->@*;
|
||||
|
||||
my @keywords = map { $_->{keywords}->@* } $self->change_types->@*;
|
||||
|
||||
# find the generics
|
||||
my @generics = grep {
|
||||
my $type = $_->{type};
|
||||
|
||||
my $res = !$type;
|
||||
|
||||
if( $type and not grep { $type eq $_} @keywords ) {
|
||||
$res = 1;
|
||||
warn "change type '$type' is not recognized\n";
|
||||
}
|
||||
$res;
|
||||
} @changes;
|
||||
|
||||
|
||||
$output .= "\n" if @generics;
|
||||
$output .= " * $_->{desc}\n" for @generics;
|
||||
|
||||
my %keyword_mapping = map {
|
||||
my $title = $_->{title};
|
||||
map { $_ => $title } $_->{keywords}->@*;
|
||||
} $self->change_types->@*;
|
||||
|
||||
|
||||
my %groups = partition_by {
|
||||
no warnings qw/ uninitialized /;
|
||||
$keyword_mapping{$_->{type}} || ''
|
||||
} @changes;
|
||||
|
||||
for my $type ( $self->change_types->@* ) {
|
||||
my $c = $groups{$type->{title}} or next;
|
||||
$output .= "\n### $type->{title}\n\n";
|
||||
$output .= $self->render_change($_) for $c->@*;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return $output . "\n";
|
||||
}
|
||||
|
||||
sub render_change($self, $change) {
|
||||
return " * " . $change->{desc} . "\n";
|
||||
}
|
||||
|
||||
sub run($self) {
|
||||
no warnings 'utf8';
|
||||
print $self->as_markdown;
|
||||
}
|
||||
|
||||
subcommand $_ => 'App::Changelord::Command::' . ucfirst $_
|
||||
for qw/ schema validate version bump init add/;
|
||||
subcommand 'schema' => 'App::Changelord::Command::Schema';
|
||||
subcommand 'validate' => 'App::Changelord::Command::Validate';
|
||||
|
||||
1;
|
||||
'end of App::Changeman';
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
package App::Changelord::Command::Add;
|
||||
|
||||
use 5.36.0;
|
||||
|
||||
use Moo;
|
||||
use CLI::Osprey desc => 'add a change to the changelog';
|
||||
|
||||
use PerlX::Maybe;
|
||||
use Path::Tiny;
|
||||
use App::Changelord::Command::Init;
|
||||
|
||||
has changelog => ( is => 'lazy' );
|
||||
|
||||
sub _build_changelog ($self) { $self->parent_command->changelog }
|
||||
|
||||
# TODO validate the type
|
||||
option type => (
|
||||
format => 's',
|
||||
doc => 'type of change',
|
||||
is => 'ro',
|
||||
);
|
||||
|
||||
option ticket => (
|
||||
format => 's',
|
||||
doc => 'associated ticket',
|
||||
is => 'ro',
|
||||
);
|
||||
|
||||
sub is_next($self,$release) {
|
||||
my $version = $release->{version};
|
||||
return !$version || $version eq 'NEXT';
|
||||
}
|
||||
|
||||
sub next_release($self) {
|
||||
my $changelog = $self->changelog;
|
||||
|
||||
my $release = $changelog->{releases}[0];
|
||||
|
||||
unless( $self->is_next($release) ) {
|
||||
unshift $changelog->{releases}->@*,
|
||||
$release = {
|
||||
version => 'NEXT',
|
||||
changes => [],
|
||||
};
|
||||
}
|
||||
|
||||
return $release;
|
||||
}
|
||||
|
||||
sub save_changelog($self) {
|
||||
my $src = $self->parent_command->source;
|
||||
|
||||
path($src)->spew( App::Changelord::Command::Init::serialize_changelog($self) );
|
||||
}
|
||||
|
||||
sub run ($self) {
|
||||
my $version = $self->next_release;
|
||||
|
||||
push $version->{changes}->@*, {
|
||||
maybe type => $self->type,
|
||||
maybe ticket => $self->ticket,
|
||||
desc => join ' ', @ARGV,
|
||||
};
|
||||
|
||||
$self->save_changelog;
|
||||
}
|
||||
|
||||
'end of App::Changelog::Command::Add';
|
||||
@ -1,81 +0,0 @@
|
||||
package App::Changelord::Command::Bump;
|
||||
|
||||
use 5.36.0;
|
||||
|
||||
use Moo;
|
||||
use CLI::Osprey desc => 'bump next version';
|
||||
|
||||
use Path::Tiny;
|
||||
use JSON;
|
||||
use YAML qw/ Bless /;
|
||||
use List::AllUtils qw/ first min uniq /;
|
||||
use Version::Dotted::Semantic;
|
||||
|
||||
with 'App::Changelord::Role::ChangeTypes';
|
||||
|
||||
has changelog => ( is => 'lazy' );
|
||||
|
||||
with 'App::Changelord::Role::Versions';
|
||||
with 'App::Changelord::Role::Stats';
|
||||
|
||||
sub _build_changelog ($self) { $self->parent_command->changelog }
|
||||
|
||||
sub run ($self) {
|
||||
my $bump = shift @ARGV;
|
||||
|
||||
if ( $bump and !grep { $_ eq $bump } qw/ minor major patch / ) {
|
||||
die "invalid bump type '$bump', must be major, minor, or patch\n";
|
||||
}
|
||||
|
||||
my $version;
|
||||
|
||||
if ($bump) {
|
||||
$version = Version::Dotted::Semantic->new( $self->latest_version );
|
||||
$version->bump($bump);
|
||||
$version = $version->stringify;
|
||||
}
|
||||
else {
|
||||
$version = $self->next_version;
|
||||
}
|
||||
|
||||
if ( $self->changelog->{releases}[0]{version}
|
||||
and $self->changelog->{releases}[0]{version} ne 'NEXT' ) {
|
||||
warn
|
||||
"No change detected since last version, hope you know what you're doing.\n";
|
||||
unshift $self->changelog->{releases}->@*, { version => 'NEXT', };
|
||||
}
|
||||
|
||||
my @time = localtime;
|
||||
|
||||
$self->changelog->{releases}[0]{version} = $version;
|
||||
$self->changelog->{releases}[0]{date} = sprintf "%d-%02d-%02d",
|
||||
$time[5] + 1900, $time[4], $time[3];
|
||||
|
||||
if( $self->changelog->{project}{with_stats} ) {
|
||||
push $self->changelog->{releases}[0]{changes}->@*, {
|
||||
type => 'stats', desc => $self->stats
|
||||
};
|
||||
}
|
||||
|
||||
my $change = $self->changelog;
|
||||
Bless($change)->keys(
|
||||
[ uniq qw/
|
||||
project releases change_types
|
||||
/, sort keys %$change
|
||||
] );
|
||||
Bless( $change->{project} )->keys(
|
||||
[ uniq qw/
|
||||
name homepage
|
||||
/, sort keys $change->{project}->%*
|
||||
] );
|
||||
|
||||
for ( grep { ref } $change->{releases}->@* ) {
|
||||
Bless($_)->keys( [ uniq qw/ version date changes /, sort keys %$_ ] );
|
||||
}
|
||||
|
||||
path( $self->parent_command->source )->spew( YAML::Dump($change) );
|
||||
|
||||
say "new version minted: $version";
|
||||
}
|
||||
|
||||
'end of App::Changelog::Command::Bump';
|
||||
@ -1,65 +0,0 @@
|
||||
package App::Changelord::Command::Init;
|
||||
|
||||
use 5.36.0;
|
||||
|
||||
use Moo;
|
||||
use CLI::Osprey desc => 'initialize new changelog source file';
|
||||
|
||||
use Path::Tiny;
|
||||
use JSON;
|
||||
use YAML qw/ Bless /;
|
||||
use List::AllUtils qw/ first min uniq /;
|
||||
use Version::Dotted::Semantic;
|
||||
|
||||
with 'App::Changelord::Role::ChangeTypes';
|
||||
|
||||
has changelog => ( is => 'lazy' );
|
||||
|
||||
with 'App::Changelord::Role::Versions';
|
||||
|
||||
sub _build_changelog ($self) { $self->parent_command->changelog }
|
||||
|
||||
sub serialize_changelog($self, $changelog = undef) {
|
||||
|
||||
$changelog //= $self->changelog;
|
||||
|
||||
Bless($changelog)->keys(
|
||||
[ uniq qw/
|
||||
project releases change_types
|
||||
/, sort keys %$changelog
|
||||
] );
|
||||
Bless( $changelog->{project} )->keys(
|
||||
[ uniq qw/
|
||||
name homepage
|
||||
/, sort keys $changelog->{project}->%*
|
||||
] );
|
||||
|
||||
for ( grep { ref } $changelog->{releases}->@* ) {
|
||||
Bless($_)->keys( [ uniq qw/ version date changes /, sort keys %$_ ] );
|
||||
}
|
||||
|
||||
return YAML::Dump($changelog);
|
||||
}
|
||||
|
||||
sub run ($self) {
|
||||
my $src = $self->parent_command->source;
|
||||
die "file '$src' already exists, aborting\n" if -f $src;
|
||||
|
||||
my $change = {
|
||||
project => {
|
||||
name => undef,
|
||||
homepage => undef,
|
||||
with_stats => 'true',
|
||||
ticket_url => undef,
|
||||
},
|
||||
change_types => $self->change_types,
|
||||
releases => [
|
||||
{ version => 'NEXT', changes => [] }
|
||||
]
|
||||
};
|
||||
path($src)->spew( $self->serialize_changelog($change) );
|
||||
|
||||
say "file '$src' created, enjoy!";
|
||||
}
|
||||
|
||||
'end of App::Changelog::Command::Init';
|
||||
@ -18,9 +18,12 @@ option json => (
|
||||
|
||||
sub run($self) {
|
||||
|
||||
my $schema = YAML::Load(path(__FILE__)->sibling('changelog-schema.yml')->slurp);
|
||||
my $schema = path(__FILE__)->sibling('changelog-schema.yml')->slurp;
|
||||
|
||||
$schema = JSON->new->pretty->encode(YAML::Load($schema));
|
||||
|
||||
print $schema;
|
||||
|
||||
print $self->json ? JSON->new->pretty->encode(YAML::Load($schema)) : YAML::Dump($schema);
|
||||
}
|
||||
|
||||
'end of App::Changelog::Command::Schema';
|
||||
|
||||
@ -1,67 +0,0 @@
|
||||
package App::Changelord::Command::Version;
|
||||
# SYNOPSIS: output the latest / next version
|
||||
|
||||
use 5.36.0;
|
||||
|
||||
use Moo;
|
||||
use CLI::Osprey
|
||||
desc => 'output the latest/next version';
|
||||
|
||||
use Path::Tiny;
|
||||
use JSON;
|
||||
use YAML::XS;
|
||||
use List::AllUtils qw/ first min /;
|
||||
use Version::Dotted::Semantic;
|
||||
|
||||
with 'App::Changelord::Role::ChangeTypes';
|
||||
|
||||
has changelog => (
|
||||
is => 'lazy'
|
||||
);
|
||||
|
||||
sub _build_changelog($self){ $self->parent_command->changelog }
|
||||
|
||||
sub latest_version($self){
|
||||
first { $_ } grep { $_ ne 'NEXT' } map { eval { $_->{version} } } $self->changelog->{releases}->@*;
|
||||
}
|
||||
|
||||
sub next_version($self) {
|
||||
my $version = Version::Dotted::Semantic->new($self->latest_version // '0.0.0');
|
||||
|
||||
my $upcoming = $self->changelog->{releases}[0];
|
||||
|
||||
if( $upcoming->{version} and $upcoming->{version} ne 'NEXT') {
|
||||
$upcoming = { changes => [] };
|
||||
}
|
||||
|
||||
my %mapping = map {
|
||||
my $level = $_->{level};
|
||||
map { $_ => $level } $_->{keywords}->@*
|
||||
} $self->change_types->@*;
|
||||
|
||||
my $bump =min 2, map { $_ eq 'major' ? 0 : $_ eq 'minor' ? 1 : 2 } map { $mapping{$_->{type}} || 'patch' } $upcoming->{changes}->@*;
|
||||
|
||||
$version->bump($bump);
|
||||
|
||||
return $version->normal;
|
||||
}
|
||||
|
||||
sub run($self) {
|
||||
my $param = shift @ARGV;
|
||||
|
||||
die "invalid parameter '$param', needs to be nothing, 'next' or 'latest'\n"
|
||||
if $param and not grep { $param eq $_ } qw/ next latest /;
|
||||
|
||||
if(!$param) {
|
||||
say "latest version: ", $self->latest_version;
|
||||
say "next version: ", $self->next_version;
|
||||
}
|
||||
elsif( $param eq 'next' ) {
|
||||
say $self->next_version;
|
||||
}
|
||||
else {
|
||||
say $self->latest_version;
|
||||
}
|
||||
}
|
||||
|
||||
'end of App::Changelog::Command::Version';
|
||||
@ -6,51 +6,30 @@ properties:
|
||||
additionalProperties: false
|
||||
properties:
|
||||
homepage:
|
||||
type: [ string, 'null' ]
|
||||
type: string
|
||||
description: url of the project's homepage
|
||||
examples:
|
||||
- https://github.com/yanick/app-changelord
|
||||
name:
|
||||
type: [ 'null', string ]
|
||||
type: string
|
||||
description: name of the project
|
||||
examples:
|
||||
- App::Changelord
|
||||
ticket_url:
|
||||
type: string
|
||||
description: perl code that takes a ticket string (e.g. 'GH123') via the `$_` variable and turns it into a link.
|
||||
examples:
|
||||
- s!GH(\d+)!https://github.com/yanick/App-Changelord/issue/$1/
|
||||
- /^\d+$/ ? "https://.../$_" : undef
|
||||
with_stats:
|
||||
description: if true, add git statistics when bumping the version.
|
||||
change_types:
|
||||
type:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
properties:
|
||||
keywords:
|
||||
type: array
|
||||
items: { type: string }
|
||||
level: { enum: [ major, minor, patch ] }
|
||||
title: { type: string }
|
||||
# properties:
|
||||
# type: object
|
||||
# properties:
|
||||
# level: { enum: [ major, minor, patch ] }
|
||||
# title: { type: string }
|
||||
releases:
|
||||
type: array
|
||||
items:
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: object
|
||||
additionalProperties: false
|
||||
properties:
|
||||
version: { type: string }
|
||||
date: { type: ['null',string] }
|
||||
changes: { type: 'array', items: { $ref: '#/$defs/change' } }
|
||||
$defs:
|
||||
change:
|
||||
type: object
|
||||
required: [ desc ]
|
||||
additionalProperties: false
|
||||
properties:
|
||||
desc: { type: string }
|
||||
ticket: { type: [ string, 'null' ] }
|
||||
type: { type: [ string, 'null' ] }
|
||||
date: { type: string }
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
package App::Changelord::Role::ChangeTypes;
|
||||
|
||||
use v5.36.0;
|
||||
|
||||
use Moo::Role;
|
||||
|
||||
use feature 'try';
|
||||
|
||||
has change_types => (
|
||||
is => 'lazy',
|
||||
);
|
||||
|
||||
sub _build_change_types($self) {
|
||||
no warnings;
|
||||
return eval {
|
||||
$self->changelog->{change_types};
|
||||
} || [
|
||||
{ title => 'Features' , level => 'minor', keywords => [ 'feat' ] } ,
|
||||
{ title => 'Bug fixes' , level => 'patch', keywords => [ 'fix' ] },
|
||||
{ title => 'Package maintenance' , level => 'patch', keywords => [ 'chore', 'maint', 'refactor' ] },
|
||||
{ title => 'Statistics' , level => 'patch', keywords => [ 'stats' ] },
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
1;
|
||||
@ -1,137 +0,0 @@
|
||||
package App::Changelord::Role::Render;
|
||||
|
||||
use v5.36.0;
|
||||
|
||||
use Moo::Role;
|
||||
|
||||
use List::AllUtils qw/ pairmap partition_by /;
|
||||
|
||||
sub render_header ($self) {
|
||||
|
||||
my $output = "# Changelog";
|
||||
|
||||
my $name = $self->changelog->{project}{name};
|
||||
|
||||
my %links = ();
|
||||
|
||||
if ( $self->changelog->{project}{homepage} ) {
|
||||
$name = "[$name][homepage]";
|
||||
$links{homepage} = $self->changelog->{project}{homepage};
|
||||
}
|
||||
|
||||
$output .= " for $name" if $name;
|
||||
|
||||
if (%links) {
|
||||
$output .= "\n\n";
|
||||
$output .= $self->render_refs(%links);
|
||||
}
|
||||
|
||||
$output .= "\n\n";
|
||||
|
||||
}
|
||||
|
||||
sub render_refs ( $self, %links ) {
|
||||
my $output = '';
|
||||
|
||||
for my $ref ( sort keys %links ) {
|
||||
$output .= " [$ref]: $links{$ref}\n";
|
||||
}
|
||||
|
||||
return $output . "\n";
|
||||
}
|
||||
|
||||
sub as_markdown ($self) {
|
||||
my $changelog = $self->changelog;
|
||||
|
||||
my $output = $self->render_header;
|
||||
|
||||
my $n = 0;
|
||||
$output .= join "\n",
|
||||
map { $self->render_release( $_, $n++ ) } $changelog->{releases}->@*;
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
sub render_release ( $self, $release, $n = 0 ) {
|
||||
|
||||
# it's a string? Okay then!
|
||||
return $release unless ref $release;
|
||||
|
||||
my $version = $release->{version} || ( $n ? '???' : 'NEXT' );
|
||||
my $date = $release->{date};
|
||||
|
||||
my $output = '';
|
||||
|
||||
$output .= "## $version";
|
||||
$output .= ", $date" if $date;
|
||||
|
||||
$output .= "\n";
|
||||
|
||||
if ( $release->{changes} ) {
|
||||
my @changes =
|
||||
map { ref ? $_ : { desc => $_ } } $release->{changes}->@*;
|
||||
|
||||
my @keywords = map { $_->{keywords}->@* } $self->change_types->@*;
|
||||
|
||||
# find the generics
|
||||
my @generics = grep {
|
||||
my $type = $_->{type};
|
||||
|
||||
my $res = !$type;
|
||||
|
||||
if ( $type and not grep { $type eq $_ } @keywords ) {
|
||||
$res = 1;
|
||||
warn "change type '$type' is not recognized\n";
|
||||
}
|
||||
$res;
|
||||
} @changes;
|
||||
|
||||
$output .= "\n" if @generics;
|
||||
$output .= join '', map { $self->render_change($_) } @generics;
|
||||
|
||||
my %keyword_mapping = map {
|
||||
my $title = $_->{title};
|
||||
map { $_ => $title } $_->{keywords}->@*;
|
||||
} $self->change_types->@*;
|
||||
|
||||
my %groups = partition_by {
|
||||
no warnings qw/ uninitialized /;
|
||||
$keyword_mapping{ $_->{type} } || ''
|
||||
}
|
||||
@changes;
|
||||
|
||||
for my $type ( $self->change_types->@* ) {
|
||||
my $c = $groups{ $type->{title} } or next;
|
||||
$output .= "\n### $type->{title}\n\n";
|
||||
$output .= $self->render_change($_) for $c->@*;
|
||||
}
|
||||
}
|
||||
|
||||
my $links = '';
|
||||
$output =~ s/(\n \[.*?\]: .*?)\n/$links .= $1;''/gem;
|
||||
|
||||
return $output . $links . "\n";
|
||||
}
|
||||
|
||||
sub render_change ( $self, $change ) {
|
||||
my $out = " * " . $change->{desc};
|
||||
|
||||
my $link = "";
|
||||
|
||||
if ( $change->{ticket} ) {
|
||||
$out .= " [$change->{ticket}]";
|
||||
if ( $self->changelog->{project}{ticket_url} ) {
|
||||
local $_ = $change->{ticket};
|
||||
eval $self->changelog->{project}{ticket_url};
|
||||
warn $@ if $@;
|
||||
if ($_) {
|
||||
$link = " [$change->{ticket}]: $_";
|
||||
$out .= "\n\n$link";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $out . "\n";
|
||||
}
|
||||
|
||||
1;
|
||||
@ -1,48 +0,0 @@
|
||||
package App::Changelord::Role::Stats;
|
||||
|
||||
use v5.36.0;
|
||||
|
||||
use Git::Repository;
|
||||
|
||||
use Moo::Role;
|
||||
|
||||
use feature 'try'; no warnings qw/ experimental /;
|
||||
|
||||
requires 'changelog';
|
||||
|
||||
# stolen from Dist::Zilla::Plugin::ChangeStats::Git
|
||||
|
||||
has repo => (
|
||||
is => 'ro',
|
||||
default => sub { Git::Repository->new( work_tree => '.' ) },
|
||||
);
|
||||
|
||||
has stats => (
|
||||
is => 'lazy' );
|
||||
|
||||
sub _build_stats ($self) {
|
||||
my $comparison_data = $self->_get_comparison_data or return;
|
||||
|
||||
my $stats = 'code churn: ' . $comparison_data;
|
||||
return $stats =~ s/\s+/ /gr;
|
||||
}
|
||||
|
||||
sub _get_comparison_data($self) {
|
||||
|
||||
# HEAD versus previous release
|
||||
# What are we diffing against? :)
|
||||
my $previous = $self->changelog->{releases}->@* > 1
|
||||
? $self->changelog->{releases}[1]{version}
|
||||
: '4b825dc642cb6eb9a060e54bf8d69288fbee4904'; # empty tree
|
||||
|
||||
my $output = eval {
|
||||
$self->repo->run( 'diff', '--shortstat', $previous, 'HEAD')
|
||||
};
|
||||
|
||||
|
||||
warn "could not gather stats: $@\n" if $@;
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
1;
|
||||
@ -1,39 +0,0 @@
|
||||
package App::Changelord::Role::Versions;
|
||||
|
||||
use v5.36.0;
|
||||
|
||||
use List::AllUtils qw/ first min /;
|
||||
use Version::Dotted::Semantic;
|
||||
|
||||
use Moo::Role;
|
||||
|
||||
use feature 'try';
|
||||
|
||||
requires 'changelog';
|
||||
|
||||
sub latest_version($self){
|
||||
first { $_ } grep { $_ ne 'NEXT' } map { eval { $_->{version} } } $self->changelog->{releases}->@*;
|
||||
}
|
||||
|
||||
sub next_version($self) {
|
||||
my $version = Version::Dotted::Semantic->new($self->latest_version // '0.0.0');
|
||||
|
||||
my $upcoming = $self->changelog->{releases}[0];
|
||||
|
||||
if( $upcoming->{version} and $upcoming->{version} ne 'NEXT') {
|
||||
$upcoming = { changes => [] };
|
||||
}
|
||||
|
||||
my %mapping = map {
|
||||
my $level = $_->{level};
|
||||
map { $_ => $level } $_->{keywords}->@*
|
||||
} $self->change_types->@*;
|
||||
|
||||
my $bump =min 2, map { $_ eq 'major' ? 0 : $_ eq 'minor' ? 1 : 2 } map { $mapping{$_->{type}} || 'patch' } $upcoming->{changes}->@*;
|
||||
|
||||
$version->bump($bump);
|
||||
|
||||
return $version->normal;
|
||||
}
|
||||
|
||||
1;
|
||||
69
t/render.t
69
t/render.t
@ -1,69 +0,0 @@
|
||||
use Test2::V0;
|
||||
|
||||
use v5.36.0;
|
||||
|
||||
package TestMe {
|
||||
use Moo;
|
||||
with 'App::Changelord::Role::Render';
|
||||
with 'App::Changelord::Role::ChangeTypes';
|
||||
|
||||
has changelog => (
|
||||
is => 'ro',
|
||||
default => sub {{
|
||||
project => { ticket_url => undef }
|
||||
}}
|
||||
);
|
||||
|
||||
sub set_url($self, $url) {
|
||||
$self->changelog->{project}{ticket_url} = $url;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
my $test = TestMe->new();
|
||||
|
||||
is $test->render_change( { desc => 'blah', ticket => 'GT123' } ),
|
||||
<<'END', "no ticket_url";
|
||||
* blah [GT123]
|
||||
END
|
||||
|
||||
$test->set_url( 's!GT!https://github.com/yanick/App-Changelord/issue/!' );
|
||||
|
||||
is $test->render_change( { desc => 'blah', ticket => 'GT123' } ),
|
||||
<<'END', 'with a ticket_url';
|
||||
* blah [GT123]
|
||||
|
||||
[GT123]: https://github.com/yanick/App-Changelord/issue/123
|
||||
END
|
||||
|
||||
$test->set_url( '$_ = undef' );
|
||||
|
||||
is $test->render_change( { desc => 'blah', ticket => 'GT123' } ),
|
||||
<<'END', 'with a ticket_url, but returns nothing';
|
||||
* blah [GT123]
|
||||
END
|
||||
|
||||
subtest 'all links go at the bottom' => sub {
|
||||
$test->set_url( 's!^!link://!' );
|
||||
|
||||
is $test->render_release({
|
||||
changes => [
|
||||
{ desc => 'this', ticket => 1 },
|
||||
{ desc => 'that', ticket => 2 },
|
||||
{ desc => 'else' },
|
||||
]
|
||||
}), <<'END';
|
||||
## NEXT
|
||||
|
||||
* this [1]
|
||||
* that [2]
|
||||
* else
|
||||
|
||||
[1]: link://1
|
||||
[2]: link://2
|
||||
END
|
||||
|
||||
|
||||
};
|
||||
|
||||
done_testing;
|
||||
27
t/stats.t
27
t/stats.t
@ -1,27 +0,0 @@
|
||||
use Test2::V0;
|
||||
|
||||
use v5.36.0;
|
||||
|
||||
package TestMe {
|
||||
use Moo;
|
||||
|
||||
has changelog => (
|
||||
is => 'ro',
|
||||
default => sub {{
|
||||
project => { ticket_url => undef },
|
||||
releases => [
|
||||
{ },
|
||||
]
|
||||
}}
|
||||
);
|
||||
|
||||
with 'App::Changelord::Role::Stats';
|
||||
with 'App::Changelord::Role::ChangeTypes';
|
||||
|
||||
}
|
||||
|
||||
my $test = TestMe->new;
|
||||
|
||||
like $test->stats => qr/code churn: /;
|
||||
|
||||
done_testing;
|
||||
26
t/versions.t
26
t/versions.t
@ -1,26 +0,0 @@
|
||||
use 5.36.0;
|
||||
|
||||
use Test2::V0;
|
||||
|
||||
use App::Changelord::Command::Version;
|
||||
|
||||
my $version = App::Changelord::Command::Version->new(
|
||||
changelog => {
|
||||
releases => [
|
||||
{ version => 'NEXT' },
|
||||
{ version => 'v1.2.3' },
|
||||
]
|
||||
}
|
||||
);
|
||||
|
||||
is $version->latest_version => 'v1.2.3';
|
||||
|
||||
is $version->next_version => 'v1.2.4';
|
||||
|
||||
$version->{changelog}{releases}[0]{changes} = [
|
||||
{ type => 'feat' }
|
||||
];
|
||||
|
||||
is $version->next_version => 'v1.3.0';
|
||||
|
||||
done_testing();
|
||||
Loading…
Reference in New Issue
Block a user