GitHub Action
install with cpm
GitHub action to install Perl modules using App::cpm
This action installs 'cpm' as root so you can then use it in your workflow.
- name: install cpm and multiple modules
uses: perl-actions/install-with-cpm@v1
with:
install: |
Simple::Accessor
Test::Parallel
# or you can use a cpanfile
# cpanfile: 'your-cpanfile'
# default values you can customize
# sudo: true
# version: main
# where to install cpm
# path: "$Config{installsitescript}/cpm"
# which perl binary to use
# perl: 'perl'Here is a sample integration using install-with-cpm action
to test your Perl Modules using multiple Perl versions via the
perl-tester images and the action perl-actions/perl-versions to rely on a dynamic list of available Perl versions.
# .github/workflows/linux.yml
jobs:
perl-versions:
runs-on: ubuntu-latest
name: List Perl versions
outputs:
perl-versions: ${{ steps.action.outputs.perl-versions }}
steps:
- id: action
uses: perl-actions/perl-versions@v1
with:
since-perl: v5.10
with-devel: false
perl_tester:
runs-on: ubuntu-latest
name: "Perl ${{ matrix.perl-version }}"
needs: [perl-versions]
strategy:
fail-fast: false
matrix:
perl-version: ${{ fromJson (needs.perl-versions.outputs.perl-versions) }}
container: perldocker/perl-tester:${{ matrix.perl-version }}
steps:
- uses: actions/checkout@v4
- name: uses install-with-cpm
uses: perl-actions/install-with-cpm@v1
with:
cpanfile: "cpanfile"
sudo: false
- run: perl Makefile.PL
- run: make testList of one or more modules, separated by a newline \n character.
Install modules from a cpanfile.
Boolean variable used to disable unit tests during installation Possible values: true | false [default: false]
Boolean variable used to install or not modules to @INC instead of local.
This variable controls the -g option from cpm and is enabled by default.
Possible values: true | false [default: true]
Extra arguments to pass to the cpm command line.
You can also use this option to run your own flavor
without the need of setting install or cpanfile.
args: "--installdeps ."Run commands as sudo: true | false [default: true]
Which perl path to use. Default to use perl from the current PATH.
Where to install cpm. Default value is $Config{installsitescript}/cpm.
Boolean variable used to control the -v flag
Possible values: true | false [default: false]
Note: this was previously set to true by default, this is now disabled to speedup installations.
Which version/tag of cpm to install. Default is 'main' to use the latest version.
none
Just install cpm without running any install commands. You can then use cpm yourself in order commands.
- name: install cpm
uses: perl-actions/install-with-cpm@v1
# then you can use it
- run: "sudo cpm install -g Simple::Accessor"Just install cpm without running any install commands. You can then use cpm yourself in order commands.
- name: install cpm
uses: perl-actions/install-with-cpm@v1
with:
version: "0.990"- name: install cpm and one module
uses: perl-actions/install-with-cpm@v1
with:
install: "Simple::Accessor"List modules seperated by a newline character \n
- name: install cpm and multiple modules
uses: perl-actions/install-with-cpm@v1
with:
install: |
Simple::Accessor
Test::Parallel- name: install cpm and files from cpanfile
uses: perl-actions/install-with-cpm@v1
with:
cpanfile: "your-cpanfile"Install modules with tests.
- name: install cpm and files from cpanfile
uses: perl-actions/install-with-cpm@v1
with:
install: "Simple::Accessor"
tests: trueDisable the -g flag.
- name: install cpm and files from cpanfile
uses: perl-actions/install-with-cpm@v1
with:
install: "Simple::Accessor"
global: false
sudo: false- name: "install cpm + cpanfile with args"
uses: perl-actions/install-with-cpm@v1
with:
cpanfile: "your-cpanfile"
args: "--with-recommends --with-suggests"Here is an extract of the possible args to use to control groups
--with-requires, --without-requires (default: with)
--with-recommends, --without-recommends (default: without)
--with-suggests, --without-suggests (default: without)
--with-configure, --without-configure (default: without)
--with-build, --without-build (default: with)
--with-test, --without-test (default: with)
--with-runtime, --without-runtime (default: with)
--with-develop, --without-develop (default: without)
Here is a sample job using cpm to install modules on windows.
windows:
runs-on: windows-latest
name: "windows"
steps:
- name: Set up Perl
run: |
choco install strawberryperl
echo "##[add-path]C:\strawberry\c\bin;C:\strawberry\perl\site\bin;C:\strawberry\perl\bin"
- run: perl -V
- uses: actions/checkout@v4
- name: "install-with-cpm"
uses: perl-actions/install-with-cpm@v1
with:
install: |
abbreviation
ACH
# checking that both modules are installed
- run: perl -Mabbreviation -e1
- run: perl -MACH -e1