package
0.0.0-20241227120803-7779d3b45fce
Repository: https://github.com/isometry/gh-promotion-app.git
Documentation: pkg.go.dev
# Functions
GitHubEmptyCommitOnBranchWithDefaultClient creates an empty commit on a branch using the default client.
NewAWSController initializes an AWS controller with customizable options and default configurations if unspecified.
NewGitHubController initializes a new GitHub controller with the provided options, setting defaults where necessary.
WithAuthMode sets the authentication mode for a GitHub instance using the given mode string.
WithAWSContext sets a custom context to be used by the AWS instance for request operations.
WithAWSController sets the awsController field of a GitHub instance with the provided AWS instance.
WithAWSLogger sets a custom slog.Logger instance for the AWS struct to use for logging operations.
WithLogger sets a custom logger for the GitHub instance to use for logging operations.
WithSSMKey sets the SSM key used for fetching credentials and applies it to the GitHub instance.
WithToken sets the GitHub authentication token for the GitHub instance.
WithWebhookSecret configures a GitHub instance to use the provided webhook secret for validating webhook signatures.
# Constants
CommitStatusError represents an error state for a commit status, used to indicate critical issues in operations.
CommitStatusFailure represents a failed state for a commit status, typically used to indicate unsuccessful operations.
CommitStatusPending represents a pending state for a commit status, typically used to indicate ongoing operations.
CommitStatusSuccess represents a successful state for a commit status, often used to indicate successful operations.
# Structs
AWS represents a wrapper for AWS services providing S3 and SSM functionality with context and logging support.
Client - cache struct holding an entry for each installation ID.
CommitOnBranchRequest is a request to create a commit on a branch.
Credentials is a helper struct to hold the GitHub credentials.
EventInstallationID represents an event payload containing an installation ID.
GitHub encapsulates GitHub-related operations and credentials management for various authentication modes.
# Type aliases
CommitStatus is a type to represent the commit status.
GHOption is a functional option used to configure or modify the properties of a GitHub instance.
Option defines a function type used to configure an instance of the AWS struct.