Skip to content

Commit

Permalink
Merge pull request #221 from gsmet/full-context
Browse files Browse the repository at this point in the history 
Better document the Context and make it easier to maintain
  • Loading branch information
@gsmet
gsmet authored Dec 15, 2023
2 parents e6aff14 + 7f7af5a commit 85535c2
Show file tree
Hide file tree
Showing 5 changed files with 527 additions and 185 deletions.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/includes/attributes.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
:quarkus-version: 3.6.0
:quarkus-version: 3.6.3
:quarkus-github-action-version: 2.0.5
2 changes: 1 addition & 1 deletion runtime/src/main/java/io/quarkiverse/githubaction/Commands.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/**
* Execute GitHub Actions commands by printing the command to the output.
*
* @see <a href="">https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions">Workflow
* @see <a href="https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions">Workflow
* commands for GitHub Actions</a>
*/
public interface Commands {
Expand Down
267 changes: 239 additions & 28 deletions runtime/src/main/java/io/quarkiverse/githubaction/Context.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,75 +4,283 @@
* The execution context of the action.
* <p>
* Expose all the information provided by GitHub.
* <p>
* See <a href="https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables">Default
* environment variables</a> for more details.
*/
public interface Context {

/**
* @return The home directory.
*/
String getHome();

String getGitHubJob();
/**
* @return The name of the action currently running, or the id of a step. For example, for an action,
* __repo-owner_name-of-action-repo.
* <p>
* GitHub removes special characters, and uses the name __run when the current step runs a script without an id. If
* you use the same script or action more than once in the same job, the name will include a suffix that consists of
* the sequence number preceded by an underscore. For example, the first script you run will have the name __run,
* and the second script will be named __run_2. Similarly, the second invocation of actions/checkout will be
* actionscheckout2.
*/
String getGitHubAction();

String getGitHubRef();
/**
* @return The path where an action is located. This property is only supported in composite actions. You can use this path
* to change directories to where the action is located and access other files in that same repository. For example,
* /home/runner/work/_actions/repo-owner/name-of-action-repo/v1.
*/
String getGitHubActionPath();

/**
* Not documented and should probably not be used.
*/
@Deprecated
String getGitHubActionRef();

String getGitHubSha();
/**
* @return For a step executing an action, this is the owner and repository name of the action. For example,
* actions/checkout.
*/
String getGitHubActionRepository();

String getGitHubRepository();
/**
* @return The name of the person or app that initiated the workflow. For example, octocat.
*/
String getGitHubActor();

String getGitHubRepositoryOwner();
/**
* @return The account ID of the person or app that triggered the initial workflow run. For example, 1234567. Note that this
* is different from the actor username.
*/
Long getGitHubActorId();

Long getGitHubRunId();
/**
* @return The API URL. For example: https://api.github.com.
*/
String getGitHubApiUrl();

Long getGitHubRunNumber();
/**
* @return The name of the base ref or target branch of the pull request in a workflow run. This is only set when the event
* that triggers a workflow run is either pull_request or pull_request_target. For example, main.
*/
String getGitHubBaseRef();

Integer getGitHubRetentionDays();
/**
* @return The path on the runner to the file that sets variables from workflow commands. This file is unique to the current
* step and changes for each step in a job. For example,
* /home/runner/work/_temp/_runner_file_commands/set_env_87406d6e-4979-4d42-98e1-3dab1f48b13a. For more information,
* see "Workflow commands for GitHub Actions."
*/
String getGitHubEnv();

Integer getGitHubRunAttempt();
/**
* @return The name of the event that triggered the workflow. For example, workflow_dispatch.
*/
String getGitHubEventName();

String getGitHubActor();
/**
* @return The path to the file on the runner that contains the full event webhook payload. For example,
* /github/workflow/event.json.
*/
String getGitHubEventPath();

String getGitHubWorkflow();
/**
* @return Returns the GraphQL API URL. For example: https://api.github.com/graphql.
*/
String getGithubGraphQLUrl();

/**
* @return The head ref or source branch of the pull request in a workflow run. This property is only set when the event
* that triggers a workflow run is either pull_request or pull_request_target. For example, feature-branch-1.
*/
String getGitHubHeadRef();

String getGitHubBaseRef();

String getGitHubEventName();

String getGitHubServerUrl();
/**
* @return The job_id of the current job. For example, greeting_job.
*/
String getGitHubJob();

String getGitHubApiUrl();
/**
* @return The path on the runner to the file that sets the current step's outputs from workflow commands. This file is
* unique to the current step and changes for each step in a job. For example,
* /home/runner/work/_temp/_runner_file_commands/set_output_a50ef383-b063-46d9-9157-57953fc9f3f0. For more
* information, see "Workflow commands for GitHub Actions."
*/
String getGitHubOutput();

/**
* @return The path on the runner to the file that sets system PATH variables from workflow commands. This file is unique to
* the current step and changes for each step in a job. For example,
* /home/runner/work/_temp/_runner_file_commands/add_path_899b9445-ad4a-400c-aa89-249f18632cf5. For more
* information, see "Workflow commands for GitHub Actions."
*/
String getGitHubPath();

String getGithubGraphQLUrl();
/**
* @return The fully-formed ref of the branch or tag that triggered the workflow run. For workflows triggered by push, this
* is the branch or tag ref that was pushed. For workflows triggered by pull_request, this is the pull request merge
* branch. For workflows triggered by release, this is the release tag created. For other triggers, this is the
* branch or tag ref that triggered the workflow run. This is only set if a branch or tag is available for the event
* type. The ref given is fully-formed, meaning that for branches the format is {@code refs/heads/<branch_name>},
* for pull requests it is {@code refs/pull/<pr_number>/merge}, and for tags it is {@code refs/tags/<tag_name>}.
* For example, {@code refs/heads/feature-branch-1}.
*/
String getGitHubRef();

/**
* @return The short ref name of the branch or tag that triggered the workflow run. This value matches the branch or tag
* name shown on GitHub. For example, feature-branch-1.
* <p>
* For pull requests, the format is {@code refs/pull/<pr_number>/merge}.
*/
String getGitHubRefName();

String getGitHubRefProtected();
/**
* @return true if branch protections or rulesets are configured for the ref that triggered the workflow run.
*/
boolean isGitHubRefProtected();

/**
* @return The type of ref that triggered the workflow run. Valid values are branch or tag.
*/
String getGitHubRefType();

String getGitHubWorkspace();
/**
* @return The owner and repository name. For example, octocat/Hello-World.
*/
String getGitHubRepository();

String getGitHubAction();
/**
* @return The ID of the repository. For example, 123456789. Note that this is different from the repository name.
*/
Long getGitHubRepositoryId();

String getGitHubEventPath();
/**
* @return The repository owner's name. For example, octocat.
*/
String getGitHubRepositoryOwner();

String getGitHubActionRepository();
/**
* @return The repository owner's account ID. For example, 1234567. Note that this is different from the owner's name.
*/
Long getGitHubRepositoryOwnerId();

String getGitHubActionRef();
/**
* @return The number of days that workflow run logs and artifacts are kept. For example, 90.
*/
Integer getGitHubRetentionDays();

String getGitHubPath();
/**
* @return A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the
* workflow run's first attempt, and increments with each re-run. For example, 3.
*/
Integer getGitHubRunAttempt();

String getGitHubEnv();
/**
* @return A unique number for each workflow run within a repository. This number does not change if you re-run the workflow
* run. For example, 1658821493.
*/
Long getGitHubRunId();

String getRunnerOs();
/**
* @return A unique number for each run of a particular workflow in a repository. This number begins at 1 for the workflow's
* first run, and increments with each new run. This number does not change if you re-run the workflow run. For
* example, 3.
*/
Long getGitHubRunNumber();

/**
* @return The URL of the GitHub server. For example: https://github.com.
*/
String getGitHubServerUrl();

/**
* @return The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the
* workflow. For more information, see "Events that trigger workflows." For example,
* ffac537e6cbbf934b08745a378932722df287a53.
*/
String getGitHubSha();

/**
* @return The path on the runner to the file that contains job summaries from workflow commands. This file is unique to the
* current step and changes for each step in a job. For example,
* /home/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c. For
* more information, see "Workflow commands for GitHub Actions."
*/
String getGitHubStepSummary();

/**
* @return The username of the user that initiated the workflow run. If the workflow run is a re-run, this value may differ
* from github.actor. Any workflow re-runs will use the privileges of github.actor, even if the actor initiating the
* re-run (github.triggering_actor) has different privileges.
*/
String getGitHubTriggeringActor();

/**
* @return The name of the workflow. For example, My test workflow. If the workflow file doesn't specify a name, the value
* of this variable is the full path of the workflow file in the repository.
*/
String getGitHubWorkflow();

/**
* @return The ref path to the workflow. For example,
* octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch.
*/
String getGitHubWorkflowRef();

/**
* @return The commit SHA for the workflow file.
*/
String getGitHubWorkflowSha();

/**
* @return The default working directory on the runner for steps, and the default location of your repository when using the
* checkout action. For example, /home/runner/work/my-repo-name/my-repo-name.
*/
String getGitHubWorkspace();

/**
* @return The architecture of the runner executing the job. Possible values are X86, X64, ARM, or ARM64.
*/
String getRunnerArch();

/**
* @return This is set only if debug logging is enabled, and always has the value of 1. It can be useful as an indicator to
* enable additional debugging or verbose logging in your own job steps.
*/
String getRunnerDebug();

/**
* @return The name of the runner executing the job. This name may not be unique in a workflow run as runners at the
* repository and organization levels could use the same name. For example, Hosted Agent
*/
String getRunnerName();

String getRunnerToolCache();
/**
* @return The operating system of the runner executing the job. Possible values are Linux, Windows, or macOS. For example,
* Windows
*/
String getRunnerOs();

/**
* @return The path to a temporary directory on the runner. This directory is emptied at the beginning and end of each job.
* Note that files will not be removed if the runner's user account does not have permission to delete them. For
* example, D:\a\_temp
*/
String getRunnerTemp();

/**
* @return The path to the directory containing preinstalled tools for GitHub-hosted runners. For more information, see
* "Using GitHub-hosted runners". For example, C:\hostedtoolcache\windows
*/
String getRunnerToolCache();

/**
* @return The runner workspace path.
*/
String getRunnerWorkspace();

String getActionsRuntimeUrl();
Expand All @@ -81,5 +289,8 @@ public interface Context {

String getActionsCacheUrl();

/**
* Print the full context, useful to inspect the values.
*/
void print();
}
Loading

0 comments on commit 85535c2

Please # to comment.