Namespace Neon.Deployment

Classes

AwsCli

Wraps the AWS-CLI with methods for common operations.

note

The class methods require that the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables be already set with the required AWS credentials.

DeploymentException

Thrown for deployement related problems.

DeploymentHelper

Deployment related defintions and utilities.

DownloadManifest

Describes a download including its parts

DownloadPart

Downloads may be split into one or more parts. This class includes the zero-based part Number which specifies the order in which this part will be assembled back into the reconsitituted download. The class also includes the Uri used to retrieve the part, the part Size, as well as the optional Md5 has for the part.

GitHub

Implements common GitHub operations via the GitHub REST API.

GitHubActionsApi

Implements GitHub Actions operations.

GitHubPackage

Describes a GitHub package.

GitHubPackageApi

Implements GitHub Packages operations.

GitHubPackageVersion

Describes a package version.

GitHubReleaseApi

Used to publish and manage GitHub releases.

GitHubRepoPath

Abstracts GitHub repo paths like: github.com/owner/repo or github.com/owner/repo, where github.com is the implied server.

GitHubTagApi

Used to manage GitHub repo tags.

MaintainerProfile

Provides the IProfileClient implementation used by NEONFORGE maintainers to obtain 1Password secrets via our internal neon-assistant tool.

NotifyClient

Implements notification operations like sending an email or a Microsoft Teams message.

note

These notifications will be sent from the devbot@neonforge.com user because that user doesn't enable multi-factor authentication (MFA) whereas our developer Office accounts do enable MFA. MFA prevents basic authentication from working.

OnePassword

Wraps the 1Password CLI.

OnePasswordException

Thrown by the OnePassword for errors.

ProfileException

Thrown by IProfileClient instance when the profile server returned an error.

ProfileHandlerResult

Describes the results returned by ProfileServer handlers.

ProfileRequest

Abstracts Neon Profile Service named pipe command requests.

ProfileResponse

Abstracts Neon Profile Service named pipe command responses.

ProfileServer

Implements a named-pipe based server that will be used to receive requests from MaintainerProfile. This server listens on a named pipe and only allows connections from other processes running on behalf of the current user.

ProfileStatus

Enumerates the profile error code strings.

XenServer

XenServer/XCP-ng related deployment utilities.

Interfaces

IProfileClient

Defines the interface for the client used to communicate with the Neon Assistant or a custom service. These services provides access to user and workstation specific settings including secrets and general properties. This is used for activities such as CI/CD automation and integration testing.

IProfileRequest

Abstracts Neon Profile Service named pipe command requests.

IProfileResponse

Abstracts Neon Profile Service named pipe command responses.

Enums

DownloadProgressType

Enumerates the types of progress indications raised when downloading a multi-part file specified by a DownloadManifest.

GitHubPackageType

Enumerates the supported GitHub package types.

GitHubPackageVisibility

Enumerates the supported GitHub package visibility types.

Delegates

DownloadProgressDelegate

Describes the callback used to monitor and possibly cancel the download of file composed of one or more parts specified by a DownloadManifest.