Table of Contents

Interface IGitHubHelper

Namespace
Invex.Atom.Module.GitHubWorkflows.Helpers
Assembly
Invex.Atom.Module.GitHubWorkflows.dll

Provides common GitHub-related parameters and functionality for Invex.Atom builds.

public interface IGitHubHelper : IBuildAccessor
Inherited Members

Remarks

Implementing this interface makes the GitHub token available as a secret parameter, which is often required for interacting with the GitHub API within workflows.

Properties

GitHubToken

Gets the GitHub token, typically used for authentication with the GitHub API.

[SecretDefinition("github-token", "GitHub Token", ParamSource.All, null)]
string GitHubToken { get; }

Property Value

string

Remarks

This is a secret parameter and should be provided securely, e.g., via GitHub Actions secrets. It grants permissions to interact with the repository and other GitHub resources.