diff options
author | Russ Allbery <rra@cpan.org> | 2020-12-24 19:21:29 -0800 |
---|---|---|
committer | Russ Allbery <rra@cpan.org> | 2020-12-24 19:32:13 -0800 |
commit | 9ebe4d2b64f3735b3b24f1035c1492ebb4cd96c9 (patch) | |
tree | 160e1bf92eac84223031d7ea0e2883758e45add3 | |
parent | b81852fb4098f56af27e26c494b32b3edd650b6e (diff) |
Drop support for support.cpan
Drop support for the support.cpan metadata key, since the CPAN RT
instance is going away. For packages with support.cpan set, if
vcs.github was set and support.github was not, set support.github to
match vcs.github during a docknot update.
Change DocKnot to point to the GitHub issue tracker and make the
same change to the affected test data.
-rw-r--r-- | Build.PL | 4 | ||||
-rw-r--r-- | Changes | 5 | ||||
-rw-r--r-- | README | 8 | ||||
-rw-r--r-- | README.md | 14 | ||||
-rw-r--r-- | docs/docknot.yaml | 2 | ||||
-rw-r--r-- | lib/App/DocKnot/Update.pm | 11 | ||||
-rw-r--r-- | share/schema/docknot.yaml | 2 | ||||
-rw-r--r-- | share/templates/readme-md.tmpl | 9 | ||||
-rw-r--r-- | share/templates/readme.tmpl | 10 | ||||
-rw-r--r-- | share/templates/thread.tmpl | 6 | ||||
-rw-r--r-- | t/data/generate/ansicolor/docknot.yaml | 2 | ||||
-rw-r--r-- | t/data/generate/ansicolor/output/readme | 8 | ||||
-rw-r--r-- | t/data/generate/ansicolor/output/readme-md | 14 | ||||
-rw-r--r-- | t/data/generate/ansicolor/output/thread | 4 | ||||
-rw-r--r-- | t/data/generate/docknot/output/thread | 4 | ||||
-rw-r--r-- | t/data/generate/pgp-sign/docknot.yaml | 2 | ||||
-rw-r--r-- | t/data/generate/pgp-sign/output/readme | 8 | ||||
-rw-r--r-- | t/data/generate/pgp-sign/output/readme-md | 14 | ||||
-rw-r--r-- | t/data/generate/pgp-sign/output/thread | 4 | ||||
-rw-r--r-- | t/data/update/ansicolor/docknot.yaml | 2 |
20 files changed, 57 insertions, 76 deletions
@@ -47,9 +47,7 @@ my $build = Module::Build->new( 'meta-spec' => { version => '2' }, resources => { bugtracker => { - mailto => 'bug-App-DocKnot@rt.cpan.org', - web => - 'https://rt.cpan.org/Dist/Display.html?Name=App-DocKnot', + web => 'https://github.com/rra/docknot/issues', }, homepage => 'https://www.eyrie.org/~eagle/software/docknot', repository => { @@ -9,6 +9,11 @@ DocKnot 4.00 (unreleased) The new metadata format is checked against a schema when read. DocKnot now depends on YAML::XS and Kwalify. + Drop support for the support.cpan metadata key, since the CPAN RT + instance is going away. For packages with support.cpan set, if + vcs.github was set and support.github was not, set support.github to + match vcs.github during a docknot update. + Word wrap numeric lists and, in Markdown output, quoted paragraphs. Previously these preserved the original spacing from the input text snippets. @@ -120,9 +120,9 @@ SUPPORT will always have the current version of this package, the current documentation, and pointers to any additional resources. - For bug tracking, use the CPAN bug tracker at: + For bug tracking, use the issue tracker on GitHub: - https://rt.cpan.org/Dist/Display.html?Name=App-DocKnot + https://github.com/rra/docknot/issues However, please be aware that I tend to be extremely busy and work projects often take priority. I'll save your report and get to it as @@ -145,9 +145,7 @@ SOURCE REPOSITORY The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull - requests are gratefully reviewed and normally accepted. It's probably - better to use the CPAN bug tracker than GitHub issues, though, to keep - all Perl module issues in the same place. + requests are gratefully reviewed and normally accepted. LICENSE @@ -127,11 +127,11 @@ The [DocKnot web page](https://www.eyrie.org/~eagle/software/docknot/) will always have the current version of this package, the current documentation, and pointers to any additional resources. -For bug tracking, use the [CPAN bug -tracker](https://rt.cpan.org/Dist/Display.html?Name=App-DocKnot). -However, please be aware that I tend to be extremely busy and work -projects often take priority. I'll save your report and get to it as soon -as I can, but it may take me a couple of months. +For bug tracking, use the [issue tracker on +GitHub](https://github.com/rra/docknot/issues). However, please be aware +that I tend to be extremely busy and work projects often take priority. +I'll save your report and get to it as soon as I can, but it may take me a +couple of months. ## Source Repository @@ -145,9 +145,7 @@ web](https://git.eyrie.org/?p=devel/docknot.git). The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull -requests are gratefully reviewed and normally accepted. It's probably -better to use the CPAN bug tracker than GitHub issues, though, to keep all -Perl module issues in the same place. +requests are gratefully reviewed and normally accepted. ## License diff --git a/docs/docknot.yaml b/docs/docknot.yaml index 66c0f65..76bf61d 100644 --- a/docs/docknot.yaml +++ b/docs/docknot.yaml @@ -35,8 +35,8 @@ distribution: debian: personal: true support: - cpan: App-DocKnot email: rra@cpan.org + github: rra/docknot web: https://www.eyrie.org/~eagle/software/docknot/ vcs: browse: https://git.eyrie.org/?p=devel/docknot.git diff --git a/lib/App/DocKnot/Update.pm b/lib/App/DocKnot/Update.pm index 21d2dc0..a950160 100644 --- a/lib/App/DocKnot/Update.pm +++ b/lib/App/DocKnot/Update.pm @@ -214,6 +214,17 @@ sub update { # Add the current format version. $data_ref->{format} = 'v1'; + # support.cpan is obsolete. If vcs.github is set and support.github is + # not, use it as support.github. + if (defined($data_ref->{support}{cpan})) { + if (!defined($data_ref->{support}{github})) { + if (defined($data_ref->{vcs}{github})) { + $data_ref->{support}{github} = $data_ref->{vcs}{github}; + } + } + delete $data_ref->{support}{cpan}; + } + # Check the schema of the resulting file. my $schema_path = $self->appdata_path('schema/docknot.yaml'); my $schema_ref = YAML::XS::LoadFile($schema_path); diff --git a/share/schema/docknot.yaml b/share/schema/docknot.yaml index 51339f5..f7ae6f1 100644 --- a/share/schema/docknot.yaml +++ b/share/schema/docknot.yaml @@ -193,8 +193,6 @@ mapping: support: type: map mapping: - cpan: - type: text email: type: text required: true diff --git a/share/templates/readme-md.tmpl b/share/templates/readme-md.tmpl index 257d12d..e46a70a 100644 --- a/share/templates/readme-md.tmpl +++ b/share/templates/readme-md.tmpl @@ -228,9 +228,7 @@ mailing list. To subscribe or see the list archives, go to the [% END %][% IF support.extra %] [% support.extra %] [% END %] -[% IF support.cpan %] -For bug tracking, use the [CPAN bug -tracker](https://rt.cpan.org/Dist/Display.html?Name=[% support.cpan %]).[% ELSIF support.github %] +[% IF support.github %] For bug tracking, use the [issue tracker on GitHub](https://github.com/[% support.github %]/issues).[% ELSE %] I welcome bug reports and patches for this package at @@ -252,12 +250,9 @@ or [view the repository on the web]([% vcs.browse %]). The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull requests are gratefully reviewed and normally accepted. -[% IF support.cpan %]It's probably better to use the CPAN bug tracker than -GitHub issues, though, to keep all Perl module issues in the same -place.[% END %] [% ELSIF vcs.type == 'Git' %] When contributing modifications, patches (possibly generated by -git-format-patch) are preferred to Git pull requests. +`git-format-patch`) are preferred to Git pull requests. [% END %] ## License diff --git a/share/templates/readme.tmpl b/share/templates/readme.tmpl index 0a099f2..9ba57d6 100644 --- a/share/templates/readme.tmpl +++ b/share/templates/readme.tmpl @@ -203,12 +203,7 @@ TESTING [% END %][% IF support.extra %] [% indent(to_text(support.extra), 2) %] [% END %] -[% IF support.cpan %] - For bug tracking, use the CPAN bug tracker at: - - https://rt.cpan.org/Dist/Display.html?Name=[% support.cpan %] - -[% ELSIF support.github %] +[% IF support.github %] For bug tracking, use the issue tracker on GitHub: https://github.com/[% support.github %]/issues @@ -238,9 +233,6 @@ SOURCE REPOSITORY The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull requests are gratefully reviewed and normally accepted. - [% IF support.cpan %]It's probably better to use the CPAN bug tracker - than GitHub issues, though, to keep all Perl module issues in the same - place.[% END %] [% ELSIF vcs.type == 'Git' %] When contributing modifications, patches (possibly generated by git-format-patch) are preferred to Git pull requests. diff --git a/share/templates/thread.tmpl b/share/templates/thread.tmpl index 23202ab..0daeb35 100644 --- a/share/templates/thread.tmpl +++ b/share/templates/thread.tmpl @@ -56,8 +56,6 @@ \link[https://github.com/[% vcs.github %]] [GitHub][% END %][% IF support.github %] \break \link[https://github.com/[% support.github %]/issues] - [Bug tracker][% ELSIF support.cpan %] \break - \link[https://rt.cpan.org/Dist/Display.html?Name=[% support.cpan %]] [Bug tracker][% END %][% IF vcs.type == 'Git' %] \break \link[[% vcs.browse %]] [Git repository][% END %][% IF vcs.status.travis %] \break @@ -157,8 +155,6 @@ also \link[[% vcs.browse %]][browse the current development source]. \doc[https://github.com/[% vcs.github %]] [GitHub][% END %][% IF support.github %] \doc[https://github.com/[% support.github %]/issues] - [Bug tracker][% ELSIF support.cpan %] - \doc[https://rt.cpan.org/Dist/Display.html?Name=[% support.cpan %]] [Bug tracker][% END %][% IF vcs.status.travis %] \doc[https://travis-ci.org/[% vcs.status.travis %]] [Travis-CI][% END %][% IF vcs.openhub %] @@ -202,8 +198,6 @@ Developer documentation: \doc[https://github.com/[% vcs.github %]] [GitHub][% END %][% IF support.github %] \doc[https://github.com/[% support.github %]/issues] - [Bug tracker][% ELSIF support.cpan %] -\doc[https://rt.cpan.org/Dist/Display.html?Name=[% support.cpan %]] [Bug tracker][% END %][% IF vcs.status.travis %] \doc[https://travis-ci.org/[% vcs.status.travis %]] [Travis-CI][% END %][% IF vcs.openhub %] diff --git a/t/data/generate/ansicolor/docknot.yaml b/t/data/generate/ansicolor/docknot.yaml index 68d6972..957e2e8 100644 --- a/t/data/generate/ansicolor/docknot.yaml +++ b/t/data/generate/ansicolor/docknot.yaml @@ -25,8 +25,8 @@ distribution: tarname: Term-ANSIColor version: term-ansicolor support: - cpan: Term-ANSIColor email: rra@cpan.org + github: rra/ansicolor web: https://www.eyrie.org/~eagle/software/ansicolor/ vcs: browse: https://git.eyrie.org/?p=perl/ansicolor.git diff --git a/t/data/generate/ansicolor/output/readme b/t/data/generate/ansicolor/output/readme index 935eae9..bb6a6c1 100644 --- a/t/data/generate/ansicolor/output/readme +++ b/t/data/generate/ansicolor/output/readme @@ -116,9 +116,9 @@ SUPPORT will always have the current version of this package, the current documentation, and pointers to any additional resources. - For bug tracking, use the CPAN bug tracker at: + For bug tracking, use the issue tracker on GitHub: - https://rt.cpan.org/Dist/Display.html?Name=Term-ANSIColor + https://github.com/rra/ansicolor/issues However, please be aware that I tend to be extremely busy and work projects often take priority. I'll save your report and get to it as @@ -141,9 +141,7 @@ SOURCE REPOSITORY The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull - requests are gratefully reviewed and normally accepted. It's probably - better to use the CPAN bug tracker than GitHub issues, though, to keep - all Perl module issues in the same place. + requests are gratefully reviewed and normally accepted. LICENSE diff --git a/t/data/generate/ansicolor/output/readme-md b/t/data/generate/ansicolor/output/readme-md index cb5082b..2504934 100644 --- a/t/data/generate/ansicolor/output/readme-md +++ b/t/data/generate/ansicolor/output/readme-md @@ -117,11 +117,11 @@ page](https://www.eyrie.org/~eagle/software/ansicolor/) will always have the current version of this package, the current documentation, and pointers to any additional resources. -For bug tracking, use the [CPAN bug -tracker](https://rt.cpan.org/Dist/Display.html?Name=Term-ANSIColor). -However, please be aware that I tend to be extremely busy and work -projects often take priority. I'll save your report and get to it as soon -as I can, but it may take me a couple of months. +For bug tracking, use the [issue tracker on +GitHub](https://github.com/rra/ansicolor/issues). However, please be +aware that I tend to be extremely busy and work projects often take +priority. I'll save your report and get to it as soon as I can, but it +may take me a couple of months. ## Source Repository @@ -136,9 +136,7 @@ web](https://git.eyrie.org/?p=perl/ansicolor.git). The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull -requests are gratefully reviewed and normally accepted. It's probably -better to use the CPAN bug tracker than GitHub issues, though, to keep all -Perl module issues in the same place. +requests are gratefully reviewed and normally accepted. ## License diff --git a/t/data/generate/ansicolor/output/thread b/t/data/generate/ansicolor/output/thread index 47ebb62..965195e 100644 --- a/t/data/generate/ansicolor/output/thread +++ b/t/data/generate/ansicolor/output/thread @@ -49,7 +49,7 @@ \link[todo.html][To-do list] \break \link[https://github.com/rra/ansicolor] [GitHub] \break - \link[https://rt.cpan.org/Dist/Display.html?Name=Term-ANSIColor] + \link[https://github.com/rra/ansicolor/issues] [Bug tracker] \break \link[https://git.eyrie.org/?p=perl/ansicolor.git] [Git repository] @@ -160,7 +160,7 @@ Developer documentation: \doc[todo.html][To-do list] \doc[https://github.com/rra/ansicolor] [GitHub] -\doc[https://rt.cpan.org/Dist/Display.html?Name=Term-ANSIColor] +\doc[https://github.com/rra/ansicolor/issues] [Bug tracker] \h2[License] diff --git a/t/data/generate/docknot/output/thread b/t/data/generate/docknot/output/thread index d72d596..81313f6 100644 --- a/t/data/generate/docknot/output/thread +++ b/t/data/generate/docknot/output/thread @@ -41,7 +41,7 @@ \link[todo.html][To-do list] \break \link[https://github.com/rra/docknot] [GitHub] \break - \link[https://rt.cpan.org/Dist/Display.html?Name=App-DocKnot] + \link[https://github.com/rra/docknot/issues] [Bug tracker] \break \link[https://git.eyrie.org/?p=devel/docknot.git] [Git repository] \break @@ -152,7 +152,7 @@ development source]. \doc[todo.html][To-do list] \doc[https://github.com/rra/docknot] [GitHub] - \doc[https://rt.cpan.org/Dist/Display.html?Name=App-DocKnot] + \doc[https://github.com/rra/docknot/issues] [Bug tracker] ] diff --git a/t/data/generate/pgp-sign/docknot.yaml b/t/data/generate/pgp-sign/docknot.yaml index 010cb48..f40d9b5 100644 --- a/t/data/generate/pgp-sign/docknot.yaml +++ b/t/data/generate/pgp-sign/docknot.yaml @@ -28,8 +28,8 @@ distribution: packaging: debian: libpgp-sign-perl support: - cpan: PGP-Sign email: rra@cpan.org + github: rra/pgp-sign web: https://www.eyrie.org/~eagle/software/pgp-sign/ vcs: browse: https://git.eyrie.org/?p=perl/pgp-sign.git diff --git a/t/data/generate/pgp-sign/output/readme b/t/data/generate/pgp-sign/output/readme index 3216fe7..d718b02 100644 --- a/t/data/generate/pgp-sign/output/readme +++ b/t/data/generate/pgp-sign/output/readme @@ -105,9 +105,9 @@ SUPPORT will always have the current version of this package, the current documentation, and pointers to any additional resources. - For bug tracking, use the CPAN bug tracker at: + For bug tracking, use the issue tracker on GitHub: - https://rt.cpan.org/Dist/Display.html?Name=PGP-Sign + https://github.com/rra/pgp-sign/issues However, please be aware that I tend to be extremely busy and work projects often take priority. I'll save your report and get to it as @@ -130,9 +130,7 @@ SOURCE REPOSITORY The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull - requests are gratefully reviewed and normally accepted. It's probably - better to use the CPAN bug tracker than GitHub issues, though, to keep - all Perl module issues in the same place. + requests are gratefully reviewed and normally accepted. LICENSE diff --git a/t/data/generate/pgp-sign/output/readme-md b/t/data/generate/pgp-sign/output/readme-md index e9aafe3..98c6488 100644 --- a/t/data/generate/pgp-sign/output/readme-md +++ b/t/data/generate/pgp-sign/output/readme-md @@ -113,11 +113,11 @@ The [PGP::Sign web page](https://www.eyrie.org/~eagle/software/pgp-sign/) will always have the current version of this package, the current documentation, and pointers to any additional resources. -For bug tracking, use the [CPAN bug -tracker](https://rt.cpan.org/Dist/Display.html?Name=PGP-Sign). However, -please be aware that I tend to be extremely busy and work projects often -take priority. I'll save your report and get to it as soon as I can, but -it may take me a couple of months. +For bug tracking, use the [issue tracker on +GitHub](https://github.com/rra/pgp-sign/issues). However, please be aware +that I tend to be extremely busy and work projects often take priority. +I'll save your report and get to it as soon as I can, but it may take me a +couple of months. ## Source Repository @@ -131,9 +131,7 @@ web](https://git.eyrie.org/?p=perl/pgp-sign.git). The eyrie.org repository is the canonical one, maintained by the author, but using GitHub is probably more convenient for most purposes. Pull -requests are gratefully reviewed and normally accepted. It's probably -better to use the CPAN bug tracker than GitHub issues, though, to keep all -Perl module issues in the same place. +requests are gratefully reviewed and normally accepted. ## License diff --git a/t/data/generate/pgp-sign/output/thread b/t/data/generate/pgp-sign/output/thread index 9fe4fdf..5376afc 100644 --- a/t/data/generate/pgp-sign/output/thread +++ b/t/data/generate/pgp-sign/output/thread @@ -52,7 +52,7 @@ \link[todo.html][To-do list] \break \link[https://github.com/rra/pgp-sign] [GitHub] \break - \link[https://rt.cpan.org/Dist/Display.html?Name=PGP-Sign] + \link[https://github.com/rra/pgp-sign/issues] [Bug tracker] \break \link[https://git.eyrie.org/?p=perl/pgp-sign.git] [Git repository] \break @@ -152,7 +152,7 @@ Developer documentation: \doc[todo.html][To-do list] \doc[https://github.com/rra/pgp-sign] [GitHub] -\doc[https://rt.cpan.org/Dist/Display.html?Name=PGP-Sign] +\doc[https://github.com/rra/pgp-sign/issues] [Bug tracker] \h2[License] diff --git a/t/data/update/ansicolor/docknot.yaml b/t/data/update/ansicolor/docknot.yaml index 3cfc953..8b3811a 100644 --- a/t/data/update/ansicolor/docknot.yaml +++ b/t/data/update/ansicolor/docknot.yaml @@ -93,8 +93,8 @@ requirements: | All are available on CPAN. Those tests will be skipped if the modules are not available. support: - cpan: Term-ANSIColor email: rra@cpan.org + github: rra/ansicolor web: https://www.eyrie.org/~eagle/software/ansicolor/ synopsis: simple ANSI text attribute control module vcs: |