Skip to content

Commit ebfe799

Browse files
authored
Merge pull request #5 from atoomic/doc++
Adjust provided example from documentation
2 parents 8c496e3 + 0297b2d commit ebfe799

File tree

1 file changed

+31
-29
lines changed

1 file changed

+31
-29
lines changed

README.md

+31-29
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ jobs:
3737
uses: perl-actions/perl-versions@v1
3838
with:
3939
since-perl: v5.20
40+
with-devel: false
4041

4142
##
42-
## Using perl-versions with perl-tester
43+
## Combining perl-versions with perl-tester
4344
##
4445
test:
4546
needs:
@@ -54,38 +55,39 @@ jobs:
5455
steps:
5556
- uses: actions/checkout@v4
5657
- run: perl -V
57-
58+
# adjust that section to fit your distribution
59+
- uses: perl-actions/ci-perl-tester-helpers/install-test-helper-deps@main
60+
- uses: perl-actions/ci-perl-tester-helpers/cpan-install-build-deps@main
61+
- uses: perl-actions/ci-perl-tester-helpers/build-dist@main
62+
- uses: perl-actions/ci-perl-tester-helpers/cpan-install-dist-deps@main
63+
- uses: perl-actions/ci-perl-tester-helpers/test-dist@main
64+
env:
65+
AUTHOR_TESTING: 1
5866
```
5967
60-
# Reusable workflow
61-
62-
There is also reusable workflow simplifying call of this action.
63-
64-
## Inputs
65-
66-
### since-perl
67-
68-
Forwarded to action.
69-
70-
## Outputs
68+
## Advanced Usages
7169
72-
### perl-version
70+
### Altering the values
7371
74-
String containing JSON array with list of Perl versions.
75-
76-
## Usage
72+
Here is an example to massage the Perl versions to append the string `-buster` to all `5.\d+` versions. (TIMTODY)
7773

7874
```yaml
79-
jobs:
8075
perl-versions:
81-
uses: perl-actions/perl-versions@v1
82-
with:
83-
since-perl: "5.14"
84-
85-
test:
86-
needs:
87-
- perl-versions
88-
strategy:
89-
matrix:
90-
perl-versions: ${{ fromJson (needs.perl-versions.outputs.perl-versions) }}
91-
```
76+
runs-on: ubuntu-latest
77+
name: List Perl versions
78+
outputs:
79+
perl-versions: ${{ steps.massage.outputs.perl-versions }}
80+
steps:
81+
- id: action
82+
uses: perl-actions/perl-versions@v1
83+
with:
84+
since-perl: v5.10
85+
with-devel: true
86+
- id: massage
87+
name: add buster
88+
run: |
89+
echo '${{ steps.action.outputs.perl-versions }}' > perl.versions
90+
perl -pi -e 's/"(\d\.\d+)"/"$1-buster"/g' perl.versions
91+
cat perl.versions
92+
echo "perl-versions=$(cat perl.versions)" >> $GITHUB_OUTPUT
93+
```

0 commit comments

Comments
 (0)