/ 
Dist-Zilla-Plugin-Deprecated-0.007
River stage one • 1 direct dependent • 2 total dependents
/ Dist::Zilla::Plugin::Deprecated

NAME

Dist::Zilla::Plugin::Deprecated - Add metadata to your distribution marking it as deprecated

VERSION

version 0.007

SYNOPSIS

In your dist.ini:

[Deprecated]

or

[Deprecated]
module = MyApp::OlderAPI

DESCRIPTION

This is a Dist::Zilla plugin that adds metadata to your distribution marking it as deprecated.

This uses the unofficial x_deprecated field, which is a new convention for marking a CPAN distribution as deprecated. You should still note that the distribution is deprecated in the documentation, for example in the abstract and the first paragraph of the DESCRIPTION section.

You can also mark a single module (or subset of modules) as deprecated by listing them with the module option. This will add an x_deprecated field to the provides section of metadata. Note that CPAN::Meta::Spec requires you to populate the rest of provides metadata through some other means, such as Dist::Zilla::Plugin::MetaProvides::Package.

Recommendations

  • When you mark a module as deprecated, prepend '(DEPRECATED)' to its abstract (the one-line module description used in the NAME pod section, which is used to populate module lists on sites such as metacpan.org).

  • Add a warning in the code (usually in the main body of the module, outside of any subroutine):

    warnings::warnif('deprecated', 'My::Module is deprecated and should no longer be used');

CONFIGURATION OPTIONS

module

[Deprecated]
module = MyApp::OlderAPI

Identify a specific module to be deprecated. Can be used more than once.

all

[Deprecated]
all = 1

Not normally needed directly. Mark an entire distribution as deprecated. This defaults to true when there are no modules listed, and false otherwise.

ACKNOWLEDGEMENTS

Neil Bowers requested this. :) And then he blogged about it.

SUPPORT

Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-Deprecated@rt.cpan.org).

There is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list.

There is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org.

I am also usually active on irc, as 'ether' at irc.perl.org.

AUTHOR

Karen Etheridge <ether@cpan.org>

CONTRIBUTOR

Neil Bowers <neil@bowers.com>

COPYRIGHT AND LICENCE

This software is copyright (c) 2015 by Karen Etheridge.

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