class Runway::GitHub
- Runway::GitHub
- Reference
- Object
Defined in:
runway/services/github.crConstructors
-
.new(log : Log, token : String | Nil = ENV.fetch("RUNWAY_GITHUB_TOKEN", nil))
The octokit class for interacting with GitHub's API @param log [Log] the logger to use @param token [String?] the GitHub token to use for authentication - if nil, the client will be unauthenticated
Instance Method Summary
-
#check_rate_limit!
A helper method to check the rate limit of the GitHub API if the rate limit is exceeded, we'll wait until the rate limit resets this is a blocking operation
- #create_deployment_status(repo : String, deployment_id : Int64, status : String) : Octokit::Models::DeploymentStatus
- #create_issue_comment_reaction(repo : String, comment_id : Int64, reaction : String) : Octokit::Models::Reaction
- #delete_issue_comment_reaction(repo : String, comment_id : Int64, reaction_id : Int64) : Bool
- #deployments(repo : String, environment : String) : Octokit::Connection::Paginator(Octokit::Models::Deployment)
- #list_deployment_statuses(repo : String, deployment_id : Int64, per_page : Int32 = 30) : Octokit::Connection::Paginator(Octokit::Models::DeploymentStatus)
Constructor Detail
The octokit class for interacting with GitHub's API @param log [Log] the logger to use @param token [String?] the GitHub token to use for authentication - if nil, the client will be unauthenticated
Instance Method Detail
def check_rate_limit!
#
A helper method to check the rate limit of the GitHub API if the rate limit is exceeded, we'll wait until the rate limit resets this is a blocking operation
def create_deployment_status(repo : String, deployment_id : Int64, status : String) : Octokit::Models::DeploymentStatus
#
def create_issue_comment_reaction(repo : String, comment_id : Int64, reaction : String) : Octokit::Models::Reaction
#
def delete_issue_comment_reaction(repo : String, comment_id : Int64, reaction_id : Int64) : Bool
#
def deployments(repo : String, environment : String) : Octokit::Connection::Paginator(Octokit::Models::Deployment)
#
def list_deployment_statuses(repo : String, deployment_id : Int64, per_page : Int32 = 30) : Octokit::Connection::Paginator(Octokit::Models::DeploymentStatus)
#