julia-actions / GitHubActions.jl

Utilities for working within GitHub Actions
MIT License
16 stars 10 forks source link

GitHubActions

Docs Build Status

Utilities for working within GitHub Actions, modelled after actions/core.

Perhaps the most common use case is to set the global logger to one compatible with GitHub Actions' log format:

In A Package

For package code, set the global logger in __init__.

using Logging: global_logger
using GitHubActions: GitHubActionsLogger
function __init__()
    get(ENV, "GITHUB_ACTIONS", "false") == "true" && global_logger(GitHubActionsLogger())
end

In Tests

In tests, set the global logger at the top level.

using Logging: global_logger
using GitHubActions: GitHubActionsLogger
get(ENV, "GITHUB_ACTIONS", "false") == "true" && global_logger(GitHubActionsLogger())

For information on the other provided functions, see the documentation.