octo_stop_commands: Stop workflow commands

In assignUser/octolog: Better 'GitHub Actions' Logging

Stop workflow commands

Description

This will stop github from processing any workflow commands until octo_start_commands() is called with the correct token. This can be used if untrusted output (e.g. issue titles, bodies or commit messages) needs to be logged this can be used to stop this output from running possibly malicious workflow commands. Requires the suggested package openssl::openssl to be installed, when used within GitHub Actions.

Usage

octo_stop_commands()

octo_start_commands(token)

Arguments

token

A unique token used to restart workflow command parsing.

Value

The token needed to reactivate the workflow command parsing. When not on GitHub Actions returns a token not generated by openssl to avoid the dependency.

See Also

The example workflow and the GitHub Blog

Examples

Sys.setenv(GITHUB_ACTIONS = "true")
tk <- octo_stop_commands()
# Commands will not be parsed by GitHub Actions
octo_start_commands(tk)

assignUser/octolog documentation built on June 4, 2023, 3:28 p.m.