File Coverage

blib/lib/Dist/Zilla/Plugin/Author/CSSON/GithubActions.pm
Criterion Covered Total %
statement 8 8 100.0
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 11 11 100.0


line stmt bran cond sub pod time code
1 1     1   107474 use 5.14.0;
  1         14  
2 1     1   6 use strict;
  1         2  
  1         19  
3 1     1   5 use warnings;
  1         2  
  1         104  
4              
5             package Dist::Zilla::Plugin::Author::CSSON::GithubActions;
6              
7             # ABSTRACT: Ease creation of common Github Actions workflows
8             our $AUTHORITY = 'cpan:CSSON'; # AUTHORITY
9             our $VERSION = '0.0107';
10              
11             __END__
12              
13             =pod
14              
15             =encoding UTF-8
16              
17             =head1 NAME
18              
19             Dist::Zilla::Plugin::Author::CSSON::GithubActions - Ease creation of common Github Actions workflows
20              
21              
22              
23             =begin html
24              
25             <p>
26             <img src="https://img.shields.io/badge/perl-5.14+-blue.svg" alt="Requires Perl 5.14+" />
27             <img src="https://img.shields.io/badge/coverage-84.6%25-orange.svg" alt="coverage 84.6%" />
28             <a href="https://github.com/Csson/p5-Dist-Zilla-Plugin-Author-CSSON-GithubActions/actions?query=workflow%3Amakefile-test"><img src="https://img.shields.io/github/workflow/status/Csson/p5-Dist-Zilla-Plugin-Author-CSSON-GithubActions/makefile-test" alt="Build status at Github" /></a>
29             </p>
30              
31             =end html
32              
33             =head1 VERSION
34              
35             Version 0.0107, released 2020-12-30.
36              
37             =head1 SYNOPSIS
38              
39             In dist.ini:
40              
41             [Author::CSSON::GithubActions::Workflow::TestWithMakefile]
42             ; set on.push.branches to an empty list
43             clear_on_push_branches = 1
44              
45             ; set on.pull_request.branches to an empty list
46             clear_on_pull_request_branches = 1
47              
48             ; add branches to on.push.branches
49             on_pull_request_branches = 'this-branch'
50             on_pull_request_branches = 'that-other-branch'
51              
52             ; add branches to on.pull_request.branches
53             on_pull_request_branches = 'my-pr-branch'
54             on_pull_request_branches = 'feature-branch'
55              
56             ; replace jobs.perl-job.strategy.matrix.os
57             matrix_os = ubuntu-latest
58             matrix_os = ubuntu-16.04
59              
60             ; replace jobs.perl-job.strategy.matrix.perl-version
61             perl_version = 5.32
62             perl_version = 5.24
63             perl_version = 5.18
64              
65             =head1 STATUS
66              
67             This plugin is very early in development. It might be released in a non-author namespace at a later stage.
68              
69             =head1 DESCRIPTION
70              
71             This distribution is a framework for creating re-usable Github Actions workflows. GitHub's documentation about Actions is located at L<http://docs.github.com/en/free-pro-team@latest/actions>.
72              
73             The core of it is the L<Dist::Zilla::Role::Author::CSSON::GithubActions> role.
74              
75             Included in this distribution is an example workflow, L<Dist::Zilla::Plugin::Author::CSSON::GithubActions::Workflow::TestWithMakefile>.
76              
77             =head1 SEE ALSO
78              
79             =over 4
80              
81             =item *
82              
83             L<Dist::Zilla::TravisCI>
84              
85             =item *
86              
87             L<http://docs.github.com/en/free-pro-team@latest/actions>
88              
89             =item *
90              
91             L<https://perlmaven.com/setup-github-actions>
92              
93             =back
94              
95             =head1 SOURCE
96              
97             L<https://github.com/Csson/p5-Dist-Zilla-Plugin-Author-CSSON-GithubActions>
98              
99             =head1 HOMEPAGE
100              
101             L<https://metacpan.org/release/Dist-Zilla-Plugin-Author-CSSON-GithubActions>
102              
103             =head1 AUTHOR
104              
105             Erik Carlsson <info@code301.com>
106              
107             =head1 COPYRIGHT AND LICENSE
108              
109             This software is copyright (c) 2020 by Erik Carlsson.
110              
111             This is free software; you can redistribute it and/or modify it under
112             the same terms as the Perl 5 programming language system itself.
113              
114             =cut