/ 
GitHub-Actions-0.2.2
River stage zero No dependents
⭐ Starred 4 GitHub stars
/ GitHub::Actions

NAME

GitHub::Actions - Work in GitHub Actions using native Perl

VERSION

This document describes GitHub::Actions version 0.2.2

SYNOPSIS

This will be in the context of a GitHub action step. You will need to install via CPAN this module first, and use perl {0} as shell. Please see below this code for instructions.


            

              
              
use GitHub::Actions;
use v5.14;
# Imported %github contains all GITHUB_* environment variables
for my $g (keys %github ) {
   say "GITHUB_$g -> ", $github{$g}
}
# The name of the repository itself, without the name part, is stored in a new variable
say $github{'REPO_NAME'};
# These are commands that mirror those in GitHub actions
# Set step output
set_output("FOO", "BAR");
# Set environment variable value
set_env("FOO", "BAR");
# Produces an error and sets exit code to 1
error( "FOO has happened" );
# Error/warning with information on file. The last 3 parameters are optional
error_on_file( "There's foo", $file, $line, "Error", $col ); #  and sets exit code to 1
warning_on_file( "There's bar", $file, $line, "Warning", $col );
# Debugging messages and warnings
debug( "Value of FOO is $bar" );
warning( "Value of FOO is $bar" );
# Start and end group
start_group( "Foo" );
# do stuff
end_group;
# Exits with error if that's the case
exit_action();
# Errors and exits
set_failed( "We're doomed" );

Install this module within a GitHub action, as a step


            

              
              
- name: "Install GitHub::Actions"
  run: sudo cpan GitHub::Actions

(we need sudo since we're using the system Perl that's installed in every runner)

Then, as another step


            

              
              
- name: Test env variables
  shell: perl {0}
  run: |
    use GitHub::Actions;
    set_env( 'FOO', 'BAR');

In most cases, you'll want to just have it installed locally in your repository and fatpack it in a script that you will upload it to the repository.

DESCRIPTION

GitHub Actions include by default, at least in its Linux runners, a system Perl which you can use directly in them. This here is a (for the time being) minimalistic module that tries to help a bit with that, by defining a few functions that will be useful when performing GitHub actions. Besides the system Perl, you can use any of the modules installed. You can install other modules via cpan or, preferably for speed, via the Ubuntu package (or equivalent).

Check out an example of using it in the repository.

INTERFACE

set_env( $env_var_name, $env_var_value)

This is equivalent to setting an environment variable

set_output( $output_name, $output_value)

Equivalent to set_output

set_failed( $error_message )

Sets the step as failed with the indicated error message and exits.

debug( $debug_message )

Equivalent to debug

error( $error_message )

Equivalent to error, prints an error message. Remember to call exit_action() to make the step fail if there's been some error.

warning( $warning_message )

Equivalent to warning, simply prints a warning.

command_on_file( $error_message, $file, $line, $title, $col )

Common code for error_on_file and warning_on_file. Can be used for any future commands.

error_on_file( $error_message, $file, $line, $title, $col )

Equivalent to error, prints an error message with file and line info. Also set the exit status to 1, so once again remember to call exit_action after calling this.

warning_on_file( $warning_message, $file, $line, $title, $col )

Equivalent to warning, prints an warning with file and line info.

set_failed( $error_message )

Exits with an error status of 1 after setting the error message.

start_group( $group_name )

Starts a group in the logs, grouping the following messages. Corresponds to group.

end_group

Ends current log grouping.

exit_action

Exits with the exit code generated during run, that is, 1 if there's been any error reported.

CONFIGURATION AND ENVIRONMENT

GitHub::Actions requires no configuration files or environment variables. Those set by GitHub Actions will only be available there, or if you set them explicitly. Remember that they will need to be set during the BEGIN phase to be available when this module loads.


            

              
              
BEGIN {
  $ENV{'GITHUB_FOO'} = 'foo';
  $ENV{'GITHUB_BAR'} = 'bar';
}

You can use this for testing, for instance, if you create any module based on this one.

DEPENDENCIES

Intentionally, no dependencies are included. Several dependencies are used for testing, though.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to https://github.com/JJ/perl-GitHub-Actions/issues.

AUTHOR

JJ Merelo <jmerelo@CPAN.org>. Many thanks to RENEEB and Gabor Szabo for their help with test and metadata.

LICENCE AND COPYRIGHT

Copyright (c) 2021, 2022 JJ Merelo <jmerelo@CPAN.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.