Package 

Object GitHubActionsLogger

  • 
public class GitHubActionsLogger

    Enables to configure GitHub Actions logger. See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#logging-commands.

    • Method Detail

      • format

         final String format(String name, Map<String, Object> params, String message)

        Emits a command. See https://github.com/actions/toolkit/blob/e8d384d3afbb1f6ab7f173155ae0404242a34d80/packages/core/src/command.ts#L32-L34.

      • startGroup

         final String startGroup(String name)

        See https://github.com/actions/toolkit/blob/master/docs/commands.md#group-and-ungroup-log-lines

      • endGroup

         final String endGroup()

        See https://github.com/actions/toolkit/blob/master/docs/commands.md#group-and-ungroup-log-lines

      • error

         final String error(String file, Integer line, Integer col, String message)

        See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-an-error-message-error

      • warning

         final String warning(String file, Integer line, Integer col, String message)

        See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-a-warning-message-warning

      • debug

         final String debug(String file, Integer line, Integer col, String message)

        See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-a-debug-message-debug

      • setOutput

         final String setOutput(String name, String value)

        Sets an action's output parameter. See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-an-output-parameter-set-output

      • addMask

         final String addMask(String value)

        Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the * character. See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#mask-a-value-in-log-add-mask

      • setEnv

         final String setEnv(String name, String value)

        Creates or updates an environment variable for any actions running next in a job. See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#set-an-environment-variable-set-env

      • addPath

         final String addPath(String path)

        Prepends a directory to the system PATH variable for all subsequent actions in the current job. The currently running action cannot access the new path variable. See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#add-a-system-path-add-path