Table of Contents

Class PermissionsEvent

Namespace
Invex.StructuredText.GithubActions.GithubActionModel
Assembly
Invex.StructuredText.GithubActions.dll

Per-scope GITHUB_TOKEN permission levels. Scopes left null are omitted from the YAML and fall back to GitHub's defaults.

public sealed record PermissionsEvent
Inheritance
object
PermissionsEvent

Constructors

PermissionsEvent()

public PermissionsEvent()

Properties

Actions

Permission for GitHub Actions workflows, runs, and artifacts (actions).

public PermissionsLevel? Actions { get; init; }

Property Value

PermissionsLevel?

Attestations

Permission for artifact attestations (attestations).

public PermissionsLevel? Attestations { get; init; }

Property Value

PermissionsLevel?

Checks

Permission for check runs and check suites (checks).

public PermissionsLevel? Checks { get; init; }

Property Value

PermissionsLevel?

Contents

Permission for repository contents, commits, branches, tags, and releases (contents).

public PermissionsLevel? Contents { get; init; }

Property Value

PermissionsLevel?

Deployments

Permission for deployments and deployment statuses (deployments).

public PermissionsLevel? Deployments { get; init; }

Property Value

PermissionsLevel?

Discussions

Permission for discussions and related comments (discussions).

public PermissionsLevel? Discussions { get; init; }

Property Value

PermissionsLevel?

IdTokens

Permission to request an OpenID Connect token (id-token).

public PermissionsLevel? IdTokens { get; init; }

Property Value

PermissionsLevel?

Issues

Permission for issues and related comments, labels, and milestones (issues).

public PermissionsLevel? Issues { get; init; }

Property Value

PermissionsLevel?

Packages

Permission for GitHub Packages (packages).

public PermissionsLevel? Packages { get; init; }

Property Value

PermissionsLevel?

Pages

Permission for GitHub Pages builds (pages).

public PermissionsLevel? Pages { get; init; }

Property Value

PermissionsLevel?

PullRequests

Permission for pull requests and related comments, labels, and reviews (pull-requests).

public PermissionsLevel? PullRequests { get; init; }

Property Value

PermissionsLevel?

RepositoryProjects

Permission for classic repository projects (repository-projects).

public PermissionsLevel? RepositoryProjects { get; init; }

Property Value

PermissionsLevel?

SecurityEvents

Permission for code scanning and Dependabot alerts (security-events).

public PermissionsLevel? SecurityEvents { get; init; }

Property Value

PermissionsLevel?

Statuses

Permission for commit statuses (statuses).

public PermissionsLevel? Statuses { get; init; }

Property Value

PermissionsLevel?

Methods

IsAll(PermissionsLevel)

Returns true when every scope is set to permission, in which case the writer can emit the compact read-all / write-all form.

public bool IsAll(PermissionsLevel permission)

Parameters

permission PermissionsLevel

The level to compare every scope against.

Returns

bool