gidgethub.actions
— Support for GitHub Actions
New in version 4.0.0.
This module is to help provide support for GitHub Actions when writing a container action.
- gidgethub.actions.workspace()[source]
Return a
pathlib.Path
object representing theGITHUB_WORKSPACE
path. As the location is considered static, the function is idempotent after its initial call.
- gidgethub.actions.event()[source]
Return the webhook event data as kept at the path as pointed at by the
GITHUB_EVENT_PATH
environment variable. As the data is considered static, the function is idempotent after its initial call.
- gidgethub.actions.command(cmd, val, **parameters)[source]
Issue a workflow command.
Note that no automatic string conversion is performed on any arguments.
# `::warning file=app.js,line=1,col=5::Missing semicolon` gidgethub.actions.command("warning", "Missing semicolon", file="app.js", line="1", col="5")
- gidgethub.actions.setenv(name, value)[source]
Creates or updates an environment variable for this action and all the subsequent actions running in the job.
Note that no automatic string conversion is performed on any arguments.
New in version 5.0.0.
- gidgethub.actions.addpath(path)[source]
Prepends the given path to the system PATH variable for this action and all the subsequent actions running in the job. The path argument can be either
str
oros.PathLike
/pathlib.Path
.New in version 5.0.0.