| action_path |
The metadata file’s path from the repository root |
| action_uri |
The action’s address on its forge without a ref: `https://github |
| actions |
The actions |
| actor_id |
The actor’s numeric id; absent for an actor type GitHub takes no id for, such… |
| actor_type |
The kind of actor, the REST field actor_type, such as Team, `RepositoryRo… |
| bypass_actors |
The actors who may bypass the ruleset |
| bypass_mode |
When the actor may bypass, the REST field bypass_mode, such as always, `p… |
| calls |
The reusable workflow the job runs, its uses value: ` |
| check_context |
The context a check run must report, the rule’s `required_status_checks[] |
| check_uri |
An identifier for the requirement |
| default |
The value used when a caller supplies none, written as a string even where th… |
| deprecation_message |
The message GitHub shows a workflow that still passes the input, the file’s `… |
| description |
What the input, output or secret is for, as the file describes it |
| do_not_enforce_on_create |
Whether a branch may be created although the check would otherwise stop it, t… |
| emitted_by |
The top-level workflow whose job reports the check |
| enforcement |
Whether GitHub enforces the ruleset, the REST field enforcement |
| input_id |
The key a caller writes in its with map |
| input_type |
The input’s type, which a reusable workflow’s input must state |
| inputs |
The inputs that the reusable workflow or the action declares |
| integration_id |
The GitHub App the check must come from, the rule’s integration_id; GitHub … |
| job_id |
The job’s key under jobs |
| job_name |
The job’s name, which GitHub shows and its check run takes; the check run t… |
| job_path |
The ids of the jobs from the top-level workflow’s job to the job that reports… |
| job_permissions |
The access the job’s own permissions key gives its GITHUB_TOKEN, in place o… |
| jobs |
The jobs under the file’s jobs key |
| output_expression |
The expression that sets the output, the file’s value key, such as one that… |
| output_id |
The key a caller reads the output by |
| outputs |
The outputs that the reusable workflow or the action declares |
| permissions |
The access the file’s top-level permissions key gives every job’s GITHUB_TO… |
| ref_name_exclude |
The refs the ruleset leaves out, from `conditions |
| ref_name_include |
The refs the ruleset applies to, from `conditions |
| required |
Whether a caller must supply a value |
| required_checks |
The status checks the rulesets require |
| requires_check |
The status checks the ruleset’s required_status_checks rule requires, each a … |
| reusable_workflows |
The reusable workflows |
| rule_types |
The type of each rule the ruleset holds, such as deletion, `non_fast_forw… |
| ruleset_id |
The ruleset’s numeric id in the REST API |
| ruleset_source |
The name of the repository, organization or enterprise that owns the ruleset,… |
| ruleset_source_type |
What owns the ruleset, the REST field source_type: a repository, an organiz… |
| ruleset_target |
What the ruleset applies to, the REST field target |
| ruleset_uri |
The ruleset’s page, the REST response’s `_links |
| rulesets |
The rulesets |
| runner_environment |
Whether the job’s runner is hosted by GitHub or by the repository’s owner, as… |
| runner_group |
The runner group the job’s `runs-on |
| runs_on |
The runner labels from the job’s runs-on: one label, a list, or the `labels… |
| secret_id |
The key a caller passes the secret under |
| secrets |
The secrets under the file’s `on |
| skip_conditions |
What in the workflow can skip the job that reports the check, each written as… |
| strict_policy |
Whether a pull request must be tested against the latest code of the branch i… |
| triggers |
The names of the events under the file’s on key, such as push, `pull_requ… |
| using |
The runtime that executes the action, its `runs |
| workflow_path |
The file’s path from the repository root, as GitHub’s build type writes workf… |
| workflow_repository |
The repository that holds the file, as GitHub’s build type writes workflow |
| workflow_uri |
The file’s address on its forge without a ref: `https://github |
| workflows |
The workflows other than the reusable ones |
