Upgrade my GitHub CI machinery to v2.0.4.

trwyant · trwyant · commit e333caacab80 · 2025-08-05T14:58:32.000-04:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,6 +1,6 @@
 # Explicit name of workflow. This is optional.
 # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#name
-name: Perl CI
+name: Perl CI v2.0.4
 
 # Specify the events that trigger this workflow.
 # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
@@ -9,6 +9,11 @@ on:
   push:
   pull_request:
 
+# Define environment variables for all jobs
+env:
+  MY_IS_GITHUB_ACTION: 1
+  PERL_CPANM_OPT: '--mirror https://cpan.metacpan.org'
+
 
 # Define the jobs that make up the workflow.
 # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobs
@@ -28,18 +33,13 @@ jobs:
 
       # The actual matrix
       matrix:
-
-        # OS environments under which the job runs.
-        runner: [windows-latest]
-        # Version of Perl to run. This specifies the most-recent Perl 5.
-        perl: [ '5' ]
-
-        # Add minimum Perl versions, which differ among operating
-        # systems
         include:
-          - runner: windows-latest
-            # v5.26.0 is the earliest known to work
-            perl: '5.26.0'
+          - perl: 5.26.0
+            runner: windows-latest
+        perl:
+          - 5
+        runner:
+          - windows-latest
     # Define where the job runs.
     # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on
     runs-on: ${{matrix.runner}}
@@ -67,29 +67,21 @@ jobs:
           perl-version: ${{ matrix.perl }}
           distribution: ${{ ( startsWith( matrix.runner, 'windows-' ) && 'strawberry' ) || 'default' }}
 
-    - name: Show Perl Version
+    - name: Show Perl and Cpanm versions
       # Run a command to display the version of Perl being used.
       run: |
         perl -v
-
-    - name: Install support modules
-      continue-on-error: true
-      run: |
         cpanm -v
-        cpanm File::HomeDir Getopt::Long version
 
     - name: Customize environment
       run: |
+        cpanm --notest File::HomeDir
         perl .github/workflows/environment.PL
 
     - name: Display local envoronment variables
       run: |
-        echo MY_HOME=${{ env.MY_HOME }}
-        echo MY_IS_GITHUB_ACTION=${{ env.MY_IS_GITHUB_ACTION }}
-        echo MY_IS_UNIX=${{ env.MY_IS_UNIX }}
-        echo MY_IS_WINDOWS=${{ env.MY_IS_WINDOWS }}
-        echo MY_TOOLCHAIN_EUMM=${{ env.MY_TOOLCHAIN_EUMM }}
-        echo MY_TOOLCHAIN_MB=${{ env.MY_TOOLCHAIN_MB }}
+        echo MY_MAKE=${{ env.MY_MAKE }}
+        echo MY_PORTABLE_HOME=${{ env.MY_PORTABLE_HOME }}
         echo MY_WANT_MODULES=${{ env.MY_WANT_MODULES }}
 
     # The current versions of various non-core toolchain modules have
@@ -101,36 +93,32 @@ jobs:
 
     - name: Install module dependencies
       run: |
-        cpanm Module::Build
         cpanm --with-configure --notest --installdeps .
 
     - name: Run ExtUtils::MakeMaker tests
-      if: env.MY_TOOLCHAIN_EUMM
+      # Abuse the hashFiles() built-in to see if file exists. From
+      # https://stackoverflow.com/questions/71336204/github-action-check-if-a-file-already-exists
+      if: ${{ hashFiles( 'Makefile.PL' ) != '' }}
       run: |
         perl Makefile.PL
-        perl .github/workflows/make.PL
-        perl .github/workflows/make.PL test
+        ${{ env.MY_MAKE }}
+        ${{ env.MY_MAKE }} test
 
     - name: Run Module::Build tests
-      if: env.MY_TOOLCHAIN_MB
+      if: ${{ hashFiles( 'Build.PL' ) != '' }}
       run: |
+        cpanm --notest Module::Build
         perl Build.PL
         ./Build
         ./Build test
 
     # The following technique from Gabor Szabo. Thanks:
     # https://perlmaven.com/install-developer-dependencies-first-test-css
-    - name: Show cpanm install log under Unix
-      if: failure() && env.MY_IS_UNIX
-      run: cat $MY_HOME/.cpanm/work/*/build.log
-
-    - name: Show cpanm install log under Windows
-      if: failure() && env.MY_IS_WINDOWS
+    # I had to change the home directory because $HOME doesn't find the
+    # logs under Windows. See .github/workflows/environment.PL for more
+    # information.
+    - name: Show cpanm install log
+      if: failure()
+      shell: bash
       run: |
-        $dirs = Get-ChildItem "$env:MY_HOME\\.cpanm\\work\\"
-        foreach ( $d in $dirs ) {
-            $file = $d.FullName + "\\build.log"
-            echo ""
-            echo $file
-            type $file
-        }
+        cat $MY_PORTABLE_HOME/.cpanm/work/*/build.log
diff --git a/.github/workflows/environment.PL b/.github/workflows/environment.PL
@@ -5,104 +5,87 @@ use 5.006002;
 use strict;
 use warnings;
 
-use Getopt::Long;
-use version;
+use Config;
 
-use constant THIS_PERL  => version->parse( $] );
-use constant PERL_5_10  => version->parse( 'v5.10.0' );
-use constant PERL_5_10_1 => version->parse( 'v5.10.1' );
-use constant PERL_5_12  => version->parse( 'v5.12.0' );
-
-unless ( caller ) {
-    my %opt;
-
-    GetOptions( \%opt,
-        qw{ verbose },
-    ) or die "Bad option\n";
+our $VERSION = '2.000004';
 
+use constant THIS_PERL  => "$]";
 
+unless ( caller ) {
     my $env_hash = compute_environment();
 
     my $env_text;
     $env_text .= "$_=$env_hash->{$_}\n" for sort keys %{ $env_hash };
 
-    $opt{verbose} and print $env_text;
-
-    defined $ENV{GITHUB_ENV}
-        and $ENV{GITHUB_ENV} ne ''
-        or die "Environment variable GITHUB_ENV undefined or empty\n";
-    open my $fh, '>>:encoding(utf-8)', $ENV{GITHUB_ENV}
-        or die "Can not open $ENV{GITHUB_ENV}: $!\n";
-
-    print { $fh } $env_text;
-
-    close $fh;
+    if ( defined( $ENV{GITHUB_ENV} ) && $ENV{GITHUB_ENV} ne '' ) {
+        open my $fh, '>>:encoding(utf-8)', $ENV{GITHUB_ENV}
+            or die "Can not open $ENV{GITHUB_ENV}: $!\n";
+        print { $fh } $env_text;
+        close $fh;
+    } else {
+        print $env_text;
+        die "Environment variable GITHUB_ENV undefined or empty\n";
+    }
 }
 
 sub compute_environment {
     my $is_windows = {
         MSWin32     => 1,
         dos         => 1,
     }->{$^O} || '';
-    my $is_unix = $is_windows ? '' : 1;
-    my $my_home;
+    my %env = (
+        MY_MAKE             => $Config{make},
+        MY_WANT_MODULES     => join( ' ', want_modules() ),
+    );
+
     {
+        # Finding the actual cpanm logs under Windows is a pain. $HOME
+        # does not point to the right place, but
+        # File::HomeDir->my_home() does. It turns out that under
+        # Windows, the Portable module (another Adam Kennedy creation)
+        # hooks itself into File::HomeDir. I don't know how it does its
+        # magic, but it is NOT equivalent to File::HomeDir::Windows.
         local $@ = undef;
+        my $src;
         eval {
             require File::HomeDir;
-            $my_home = File::HomeDir->my_home();
-            print "Home from File::HomeDir\n";
+            $env{MY_PORTABLE_HOME} = File::HomeDir->my_home();
+            # Windows seems to need a Posix path or bash glob doesn't
+            # work.
+            $is_windows
+                and $env{MY_PORTABLE_HOME} =~ tr|\\|/|;
+            no warnings qw{ once };
+            $src = $File::HomeDir::IMPLEMENTED_BY;
             1;
         } or do {
-            $my_home = $ENV{HOME};
-            print "Home from \$HOME\n";
+            $env{MY_PORTABLE_HOME} = $ENV{HOME};
+            $src = '$HOME';
         };
+        print "MY_PORTABLE_HOME from $src is $env{MY_PORTABLE_HOME}\n";
     }
-    my @want_modules = want_modules();
-    my %env = (
-        MY_HOME             => $my_home,
-        MY_IS_GITHUB_ACTION => 1,
-        MY_IS_UNIX          => $is_unix,
-        MY_IS_WINDOWS       => $is_windows,
-        MY_TOOLCHAIN_EUMM   => -e 'Makefile.PL' ? 1 : '',
-        MY_TOOLCHAIN_MB     => -e 'Build.PL' ? 1 : '',
-        MY_WANT_MODULES     => "@want_modules",
-    );
 
     $is_windows
         and @env{ qw{ LINES COLUMNS } } = ( 24, 80 );
 
     return \%env;
 }
 
-# FIXME Not all my distros need HTML-Tagset. Figure out a way to handle
-# this other than by bashing this script. This is not straightforward
-# because HTML-Tagset is probably not a direct dependency.
+# NOTE that we rely on the templating system's perl::Type module to
+# compute recursive dependencies to figure out which possibly-indirect
+# dependencies we need to handle under old Perls.
 sub want_modules {
     my ( $perl_ver ) = @_;
     defined $perl_ver
         or $perl_ver = THIS_PERL;
-    if ( $perl_ver >= PERL_5_12 ) {
-        return;
-    } elsif ( $perl_ver >= PERL_5_10_1 ) {
-        # NOTE that, thus far, XSLoader, Test-Deep, and Perl-Critic are
-        # only needed for Perl-Critic policies, and maybe not all of
-        # those.
-        # NOTE that, thus far, HTML-Tagset is only needed for modules
-        # that make use of libwww-perl, directly or indirectly.
-        return qw{
-            RRA/podlators-4.14.tar.gz
-        };
-    } elsif ( $perl_ver >= PERL_5_10 ) {
-        return qw{
-            RRA/podlators-4.14.tar.gz
-        };
-    } else {
-        return qw{
-            SMUELLER/ExtUtils-ParseXS-3.30.tar.gz
-            RRA/podlators-4.14.tar.gz
-        };
+    foreach (
+	[ qw{ 5.010001  } ],
+	[ qw{ 5.000000 XSLoader@0.10 } ],
+    ) {
+        my ( $version, @want ) = @{ $_ };
+        $perl_ver >= $version
+            and return @want;
     }
+    die "Bug - Unsupported perl version $]";
 }
 
 1;
@@ -116,42 +99,27 @@ environment.PL - Customize GitHub Actions environment
 =head1 SYNOPSIS
 
  .github/workflows/environment.PL
- .github/workflows/environment.PL --verbose
 
 =head1 OPTIONS
 
-=head2 --verbose
-
-If this Boolean option is asserted, the environment variables defiend
-are written to standard output.
-
-The default is C<--no-verbose>.
+None.
 
 =head1 DETAILS
 
 This Perl script adds environment variables to the GitHub Actions
 environment. The following environment variables are added:
 
-=head2 MY_HOME
-
-The job's home directory, as determined by
-L<File::HomeDir|File::HomeDir>.
-
-=head2 MY_IS_GITHUB_ACTION
+=head2 COLUMNS
 
-Always true (i.e. C<'1'>).
+Windows only. C<'80'>.
 
-=head2 MY_IS_UNIX
+=head2 LINES
 
-True (i.e. C<1>) if running under some flavor of Unix, and false (i.e.
-C<''>) otherwise. At the moment this is the Boolean inverse of
-L<MY_IS_WINDOWS|/MY_IS_WINDOWS>.
+Windows only. C<'24'>.
 
-=head2 MY_IS_WINDOWS
+=head2 MY_MAKE
 
-True (i.e. C<1>) if running under Windows, and false (i.e. C<''>)
-othewise. At the moment this is true if C<$^O> is C<'MSWin32'> or
-C<'dos'>.
+The value of C<$Config{make}>.
 
 =head2 MY_WANT_MODUKES
 
@@ -173,19 +141,18 @@ that describes the environment variables to be added to the environment.
 
 =head2 want_modules
 
-This subroutine takes an optional L<version|version> object representing
-a Perl version, and returns a list of modules or distributions to be
-installed that version B<before> module prerequisites are
-processed. If no argument is provided, the version of the
-currently-running Perl is assumed.
+This subroutine takes an optional Perl version, and returns a list of
+modules or distributions to be installed that version B<before> module
+prerequisites are processed. If no argument is provided, the version of
+the currently-running Perl is assumed.
 
 =head1 AUTHOR
 
 Thomas R. Wyant, III F<wyant at cpan dot org>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (C) 2022 by Thomas R. Wyant, III
+Copyright (C) 2025 by Thomas R. Wyant, III
 
 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl 5.10.0. For more details, see the full text
diff --git a/.github/workflows/make.PL b/.github/workflows/make.PL
