Dist::...ources(3pm)

πŸ“¦
version 1.21 Β· 2 versions
  • 1.21 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 1.21 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– Dist::Zilla::Plugin::AutoMetaResources β€” AutoMetaResources πŸ’–

okay bestie, so this page lives in the Dist::...ources(3pm) slot of your friendly neighbourhood User Contributed Perl Documentation, and it's about a plugin that does your metadata chores for you. Automagical MetaResources, no cap. ✨


✨ VERSION ✨

version 1.21 β€” that's the one, that's the vibe. πŸŽ€


🌸 SYNOPSIS 🌸

so like, in your dist.ini:

# dist.ini
name = Dist-Zilla-Plugin-AutoMetaResources
...

[AutoMetaResources]
bugtracker.github  = user:ajgb
repository.github  = user:ajgb
homepage           = https://metacpan.org/release/%{dist}

orrr if you're doing the PluginBundle::Easy thing:

$self->add_plugins(
    [
        AutoMetaResources => {
            'bugtracker.github' => [{ user => 'ajgb' }],
            'repository.github' => [{ user => 'ajgb' }],
            'homepage' => 'https://metacpan.org/release/%{dist}',
        }
    ]
);

and the tea is β˜• both of those, for Dist::Zilla::Plugin::AutoMetaResources, would be equivalent of:

[MetaResources]
bugtracker.web    = https://github.com/ajgb/dist-zilla-plugin-autometaresources/issues
repository.url    = git://github.com/ajgb/dist-zilla-plugin-autometaresources.git
repository.web    = http://github.com/ajgb/dist-zilla-plugin-autometaresources
repository.type   = git
homepage          = https://metacpan.org/release/Dist-Zilla-Plugin-AutoMetaResources

like… the glow-up is real. πŸ”₯


πŸ’… DESCRIPTION πŸ’…

okay so picture this: you're out here typing your dist name into the config again. and again. and again. annoying. 😭 if that's giving you the ick, this plugin comes to the rescue! it's literally the whole point. πŸ¦‹


🌈 CONFIGURATION 🌈

most of the known resources just need a lil boolean flag to be enabled β€” one (1) yes, that's it. but you're free to pass your own options too, bestie:

bugtracker.rt =  dist:Other-Name;lcdist:other-name

which gets transformed into:

[{
    dist => 'Other-Name',
    lcdist => 'other-name',
}]

πŸ› BUGTRACKER πŸ›

RT bugtracker:

[AutoMetaResources]
bugtracker.rt = 1

# same as
[MetaResources]
bugtracker.web    = https://rt.cpan.org/Public/Dist/Display.html?Name=%{dist}
bugtracker.mailto = bug-%{dist}@rt.cpan.org

GitHub issues:

[AutoMetaResources]
bugtracker.github = user:ajgb

# same as
[MetaResources]
bugtracker.web    = http://github.com/ajgb/%{lcdist}/issues

Bitbucket issues:

[AutoMetaResources]
bugtracker.bitbucket = user:ajgb

# same as
[MetaResources]
bugtracker.web    = https://bitbucket.org/ajgb/%{lcdist}/issues

🧚 REPOSITORY 🧚

GitHub repository:

[AutoMetaResources]
repository.github = user:ajgb
# or
repository.GitHub = user:ajgb

# same as
[MetaResources]
repository.url    = git://github.com/ajgb/%{lcdist}.git
repository.web    = http://github.com/ajgb/%{lcdist}
repository.type   = git

iykyk, the case doesn't matter β€” github and GitHub both ate. πŸ’…

Bitbucket repository:

[AutoMetaResources]
repository.bitbucket = user:ajgb

# same as
[MetaResources]
repository.url    = git://bitbucket.org:ajgb/%{lcdist}.git
repository.web    = https://bitbucket.org/ajgb/%{lcdist}
repository.type   = git

Git Moose repository:

[AutoMetaResources]
repository.gitmo = 1

# same as
[MetaResources]
repository.url    = git://git.moose.perl.org/%{dist}.git
repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo/%{dist}.git;a=summary
repository.type   = git

Catalyst Subversion repository:

[AutoMetaResources]
repository.catsvn = 1

# same as
[MetaResources]
repository.url    = http://dev.catalyst.perl.org/repos/Catalyst/%{dist}/
repository.web    = http://dev.catalystframework.org/svnweb/Catalyst/browse/%{dist}
repository.type   = svn

Shadowcat's Git repositories:

[AutoMetaResources]
repository.catagits = 1

# same as
[MetaResources]
repository.url    = git://git.shadowcat.co.uk/catagits/%{dist}.git
repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits/%{dist}.git;a=summary
repository.type   = git

and ✨

[AutoMetaResources]
repository.p5sagit = 1

# same as
[MetaResources]
repository.url    = git://git.shadowcat.co.uk/p5sagit/%{dist}.git
repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/%{dist}.git;a=summary
repository.type   = git

and ✨

[AutoMetaResources]
repository.dbsrgits = 1

# same as
[MetaResources]
repository.url    = git://git.shadowcat.co.uk/dbsrgits/%{dist}.git
repository.web    = http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/%{dist}.git;a=summary
repository.type   = git

⭐ OTHER ⭐

[AutoMetaResources]
homepage = https://metacpan.org/release/%{dist}

you're free to pass other valid metadata options to be included as resources, bestie β€” go off. πŸ’– and the values can contain these lil variables:

  • %{dist} β€” name of the distribution πŸ‘‘
  • %{lcdist} β€” name of the distribution, but lowercase 🫢

πŸŽ€ AUTHOR πŸŽ€

Alex J. G. BurzyXski <ajgb@cpan.org> β€” the icon, the moment, the main character. πŸ’œ


This software is copyright (c) 2013 by Alex J. G. BurzyXski <ajgb@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. πŸ’…


and that's the whole page, no notes πŸ“ β€” brought to you by perl v5.34.0, dated 2022-06-13, filed under Dist::...ources(3pm). mwah, ily, go ship some dists. πŸŒˆπŸ’–βœ¨

πŸ“¦ where this page comes from