App::Workflows::Github
push to main | |||
scheduled run | |||
pull request |
NAME
App::Workflows::Github - the CI/CD workflow collection for Raku Module developers.
SYNOPSIS
zef install App::Workflows::Github
cd your-module-directory
create-workflows-4-github
Then do the usual ... git add/commit/push to github and open https://github.com/your-name/your-module/actions to check the results.
To dispatch a workflow using gh do
cd your-module-directory
gh workflow run 'dispatch' --ref branch-to-run-on -f verbosity=debug -f os=windows -f run_prove6=true -f install_module=true -f skip_deps_tests=false
For 'os' you can choose any of 'ubuntu|macos|ubuntu'. Alternative use https://github.com/Your-Name/Your-App/actions/workflows/dispatch.yml to set the parameters and launch a run.
image resources/dispatch-screenshot.png not found
DESCRIPTION
App::Workflows::Github is collecting Github workflows for testing your Module on Linux, MacOS and Windows.
No worries, even if you discover that your module fails for any of the three operating systems, you still can
a.) ignore it, or
b.) if any of your dependencies is failing
open a ticket and make the author of this dependency aware
use another module as a dependency implementing the same functionality which works for the OS you need
implement it yourself
c.) fix your own code, if it is realy you (unlikely, but possible :-) creating the inconvinience for the users of your module.
Scheduled workflows only run automatically if the .yml files are pushed to the default branch - usually 'main'.
AUTHOR
rcmlz [email protected]
COPYRIGHT AND LICENSE
Copyright 2023 rcmlz
This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.