Dist::Zilla::Plugin::SetEnv - Set various environment variables
This document describes version 0.001 of Dist::Zilla::Plugin::SetEnv (from Perl distribution Dist-Zilla-Plugin-SetEnv), released on 2016-10-08.
In dist.ini:
[SetEnv]
This plugin sets various environment variables so when one of your plugins runs another program or script, the program can get various information about Dist::Zilla or the building process through the environment variables.
Plugin ordering is important. Generally you should put this SetEnv plugin before any other plugin that you might want to run programs from, so SetEnv already has the chance to set e.g. DZIL_PHASE.
DZIL_PHASE
Can be used by programs/scripts to tell that they are running under Dist::Zilla.
This is set to 1 at the "before build" phase.
Can be used by programs/scripts to tell what distribution is being built.
This is set to $zilla->name at the "before build" phase.
$zilla->name
Example: App-YourApp
App-YourApp
Can be used by programs/scripts to tell what phase they are in.
This is set to before_build at the "before build" phase.
before_build
Set to before_mint at the "before mint" phase.
before_mint
Set to before_release at the "before release" phase.
before_release
Set to make_module at the "make module" (ModuleMaker) phase.
make_module
Set to gather_files at the "file gathering" phase.
gather_files
Set to set_file_encodings at the "set file encodings" phase.
set_file_encodings
Set to prune_files at the "file pruning" phase.
prune_files
Set to provide_version at the "provide version" phase.
provide_version
Set to munge_files at the "file munging" phase.
munge_files
Set to register_prereqs at the "register prereqs" phase.
register_prereqs
Set to provide_meta at the "meta provider" phase.
provide_meta
Set to setup_installer at the "setup installer" phase.
setup_installer
Set to before_archive at the "before archive" phase.
before_archive
Set to after_build at the "after build" phase.
after_build
Set to after_mint at the "after mint" phase.
after_mint
Set to after_release at the "after release" phase.
after_release
Included for completeness. This is not set by this plugin, but by Dist::Zilla itself at the beginning of the release process.
Can be used by programs/scripts to tell that they are in a release process.
Can be used by programs/scripts to tell that they are in a test process.
Conditionally set to 1 at the "before build" phase.
Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-SetEnv.
Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-SetEnv.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-SetEnv
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Dist::Zilla::Plugin::ReportPhase
perlancar <perlancar@cpan.org>
This software is copyright (c) 2016 by perlancar@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.
To install Dist::Zilla::Plugin::SetEnv, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::SetEnv
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::SetEnv
For more information on module installation, please visit the detailed CPAN module installation guide.