Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #70: update the README #71

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Issue #70: update the README #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
83ddaff
Move the declaration for Pod::Readme
bschmalhofer Sep 29, 2024
32f4ce9
State that Perl 5.10 is the earliest supported version
bschmalhofer Sep 29, 2024
e908d82
Sync README.md with cpanfile.
bschmalhofer Sep 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 49 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# docker-perl-tester

This repo is used to build Perl Docker images with various pre-installed bits:
The earliest supported version is Perl 5.10.

- the `aspell` and `aspell-en` packages
- `build-essential`
- `git`
- `cpanminus`
- `App::cpm`
- `Devel::Cover`
Expand All @@ -20,25 +23,32 @@ on failures.
See also the `cpanfile` in this repo for an up to date list of available
modules.

Note that on older versions of Perl older Perl modules might be required. Examples for
such cases are Perl::Critic, Pod::Man, and Software::License::Perl_5.

## Available on all Perl Versions

- Code::TidyAll::Plugin::SortLines::Naturally
- Code::TidyAll::Plugin::UniqueLines
- App::cpanoutdated
- Devel::Cover
- Devel::Cover::Report::Codecov
- Devel::Cover::Report::Coveralls
- ExtUtils::MakeMaker
- File::Temp
- List::MoreUtils
- Minilla
- Module::Build
- Pod::Coverage::TrustPod
- Perl::Critic
- Perl::Tidy
- Pod::Man
- Pod::Spell
- Software::License::Perl_5
- Test2::Bundle::Extended
- Test2::Harness
- Test2::Plugin::NoWarnings
- Test2::Suite
- Test2::Tools::Explain
- Test::Builder
- Test::CPAN::Meta
- Test::Deep
- Test::Differences
- Test::EOL
- Test::Fatal
Expand All @@ -48,29 +58,61 @@ modules.
- Test::More
- Test::Needs
- Test::Notabs
- Test::Perl::Critic
- Test::Pod
- Test::Pod::Coverage
- Test::Portability::Files
- Test::RequiresInternet
- Test::Simple
- Test::Spelling
- Test::Synopsis
- Test::Vars
- Test::Version
- Test::Warnings

## Only on Perl 5.10 and later
## Only on Perl 5.10
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could clarify about these. We are pinning to specific versions on 5.10 as those should be the last 5.10 supported versions of those modules. They should also get installed in more recent Perls, but we haven't specified a version requirement. If they're not specifically listed elsewhere, I assume they are pulled in via dependencies or they were at the time when the change was made.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I thought the same. I'll verify that these are actually pulled in as dependencies and explicitly list them in the cpanfile. This means that fewer cases must be distinguished in Readme.mk.


- Code::TidyAll::Plugin::Test::Vars
- Test::Vars
- Data::OptList
- Data::Section
- Plack
- Sub::Exporter
- Test::Deep

## Only on Perl 5.10.001 and later

- Test2::Harness::Renderer::JUnit

## Only on Perl 5.12 and later

- Code::TidyAll::Plugin::SortLines::Naturally
- Code::TidyAll::Plugin::Test::Vars
- Code::TidyAll::Plugin::UniqueLines
- Plack::Test (usually as part of the distribution Plack)
- Pod::Coverage::TrustPod
- Pod::Readme

## Only on Perl 5.10 and Perl 5.12

- IO::Socket::IP (this might be an implicit dependendcy on other versions of Perl)

## Only on Perl 5.20 and later

- Dist::Zilla & friends
- Dist::Zilla::PluginBundle::Author::ETHER
- Dist::Zilla::PluginBundle::Author::OALDERS
- Dist::Zilla::PluginBundle::DROLSKY
- Dist::Zilla::PluginBundle::Milla
- Dist::Zilla::PluginBundle::RJBS
- Dist::Zilla::PluginBundle::Starter::Git
- Dist::Zilla::Plugin::CheckChangeLog
- Dist::Zilla::Plugin::CopyFilesFromRelease
- Dist::Zilla::Plugin::Deprecated
- Dist::Zilla::Plugin::Git::Contributors
- Dist::Zilla::Plugin::GitHubREADME::Badge
- Dist::Zilla::Plugin::OurPkgVersion
- Dist::Zilla::Plugin::Regenerate::AfterReleasers
- Dist::Zilla::Plugin::StaticInstall
- Dist::Zilla::Plugin::Test::ReportPrereqs

# Using Docker Images for your projects

Expand Down
2 changes: 1 addition & 1 deletion cpanfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ requires 'File::Temp';
requires 'List::MoreUtils';
requires 'Module::Build';
requires 'Perl::Tidy', '>= 20220217';
requires 'Pod::Readme' if "$]" >= 5.012000;
requires 'Pod::Spell', '>= 1.25';
requires 'Test2::Bundle::Extended';
requires 'Test2::Plugin::NoWarnings';
Expand Down Expand Up @@ -76,6 +75,7 @@ if ( "$]" >= 5.012 ) {
requires 'Code::TidyAll::Plugin::Test::Vars';
requires 'Code::TidyAll::Plugin::UniqueLines';
requires 'Pod::Coverage::TrustPod';
requires 'Pod::Readme';
}

if ( "$]" < 5.014 ) {
Expand Down