• NeonSDK
  • NeonKUBE
Search Results for

    Show / Hide Table of Contents
    • Neon
      • Build
    • Neon.Blazor
      • BlazorHelper
      • BodyOutlet
      • ClientRenderContext
      • DOMRectReadOnly
      • EventHandlers
      • FileDownloader
      • HtmlElement
      • IRenderContext
      • IntersectionChangedEventArgs
      • IntersectionObserver
      • IntersectionObserverContext
      • MobileDetector
      • NeonBlazorExtensions
      • ServerRenderContext
      • SwipeDirection
      • SwipeHandler
    • Neon.Blazor.Analyzers
      • SvgGenerator
      • SvgGenerator.Svg
    • Neon.BuildInfo
      • ThisAssembly
      • ThisAssembly.Git
      • ThisAssembly.Git.BaseVersion
      • ThisAssembly.Git.SemVer
    • Neon.CSharp
      • CSharpHelper
      • CompilerErrorException
      • MetadataReferences
    • Neon.Cassandra
      • KeyspaceStatus
      • RowSetExtensions
      • SchemaManager
      • SchemaManagerException
      • SchemaStatus
      • SessionExtensions
    • Neon.Collections
      • ArgDictionary
      • Bits
      • IObjectDictionary
      • NiceDictionary<TKey, TValue>
      • ObjectDictionary
    • Neon.Common
      • AppDomainExtensions
      • Block
      • BlockArray
      • ByteEncoding
      • ByteUnits
      • CommandLine
      • CommandLine.OptionDefinition
      • CommandLine.Redactor
      • CpuArchitecture
      • Credentials
      • DateTimeExtensions
      • EnumExtensions
      • EnvironmentParser
      • EnvironmentParser.Parser<T>
      • EnvironmentParser.Validator<T>
      • EnvironmentParser.VariableSource
      • ExceptionExtensions
      • ExecuteException
      • ExecuteResponse
      • GlobPattern
      • HexDumpOption
      • HttpClientExtensions
      • HttpResponseMessageExtensions
      • IEnumerableExtensions
      • ILabeled
      • IOExtensions
      • IServiceContainer
      • IStaticDirectoryExtensions
      • LabelSelector
      • LabelSelectorOptions
      • LabelSelector<TItem>
      • NeonAssemblyExtensions
      • NeonExtendedHelper
      • NeonHelper
      • NetFramework
      • NewtonsoftExtensions
      • NotReadyException
      • ProcessExtensions
      • ProgramEntrypoint
      • ProgramEntrypointAsync
      • ProgramExitException
      • ProgramRunner
      • RandomExtensions
      • ReflectionExtensions
      • SemanticVersion
      • ServiceContainer
      • StaticZipOptions
      • StringBuilderExtensions
      • StringExtensions
      • Stub
      • Stub.Value
      • TaskExtensions
      • TimeSpanExtensions
      • ToolException
      • TriState
      • WeakEventController
      • WindowsEdition
      • WindowsFeatureStatus
      • YamlDotNetExtensions
    • Neon.Cryptography
      • AesCipher
      • CryptoExtensions
      • CryptoHelper
      • NeonVault
      • Wildcard
    • Neon.Csv
      • CsvReader
      • CsvTableReader
      • CsvTableWriter
      • CsvWriter
    • Neon.Data
      • DateTimeJsonConverter
      • DateTimeOffsetJsonConverter
      • IEnhancedJsonConverter
      • IGeneratedServiceClient
      • IPersistableType
      • IPersistableType<T>
      • IRoundtripData
      • IntegerEnumConverter<TEnum>
      • NotifyPropertyChanged
      • RoundtripDataFactory
      • RoundtripDataHelper
      • TimeSpanJsonConverter
      • VersionJsonConverter
    • Neon.Deployment
      • AwsCli
      • DeploymentException
      • DeploymentHelper
      • DownloadManifest
      • DownloadPart
      • DownloadProgressDelegate
      • DownloadProgressType
      • GitHub
      • GitHubActionsApi
      • GitHubPackage
      • GitHubPackageApi
      • GitHubPackageType
      • GitHubPackageVersion
      • GitHubPackageVisibility
      • GitHubReleaseApi
      • GitHubRepoPath
      • GitHubTagApi
      • IProfileClient
      • IProfileRequest
      • IProfileResponse
      • MaintainerProfile
      • NotifyClient
      • OnePassword
      • OnePasswordException
      • ProfileException
      • ProfileHandlerResult
      • ProfileRequest
      • ProfileResponse
      • ProfileServer
      • ProfileStatus
      • XenServer
    • Neon.Deployment.CodeSigning
      • AzureProfile
      • CodeSigner
      • UsbTokenProfile
    • Neon.Diagnostics
      • AssertException
      • ConfigExtensions
      • ConsoleJsonLogExporter
      • ConsoleJsonLogExporterOptions
      • ConsoleTextLogExporter
      • ConsoleTextLogExporterOptions
      • ExceptionInfo
      • FileLogExporter
      • FileLogExporterFormat
      • FileLogExporterOptions
      • LogAsTraceProcessor
      • LogAsTraceProcessorOptions
      • LogAttributeNames
      • LogAttributes
      • LogEvent
      • LogEventInterceptor
      • LoggerExtensions
      • NullLogger
      • TelemetryHub
      • TelemetrySpanEventNames
      • TelemetrySpanExtensions
    • Neon.Docker
      • DockerClient
      • DockerNetwork
      • DockerNetworkContainer
      • DockerNetworkIpam
      • DockerNode
      • DockerNodeManagerStatus
      • DockerResponse
      • DockerSettings
      • DockerVolume
      • NetworkCreateResponse
      • ServiceBindOptions
      • ServiceConfig
      • ServiceContainerSpec
      • ServiceCredentialSpec
      • ServiceDetails
      • ServiceDiscreteResourceSpec
      • ServiceDnsConfig
      • ServiceEndpoint
      • ServiceEndpointMode
      • ServiceEndpointPortConfig
      • ServiceEndpointSpec
      • ServiceFile
      • ServiceGenericResources
      • ServiceGlobalSchedulingMode
      • ServiceHealthCheck
      • ServiceIsolationMode
      • ServiceListResponse
      • ServiceLogDriver
      • ServiceMode
      • ServiceMount
      • ServiceMountBindPropagation
      • ServiceMountConsistency
      • ServiceMountType
      • ServiceNamedResourceSpec
      • ServiceNetwork
      • ServicePlacement
      • ServicePlacementPreferences
      • ServicePlacementSpreadSettings
      • ServicePlatform
      • ServicePortMode
      • ServicePortProtocol
      • ServicePrivileges
      • ServiceReplicatedSchedulingMode
      • ServiceResourceSettings
      • ServiceResources
      • ServiceRestartCondition
      • ServiceRestartPolicy
      • ServiceRollbackConfig
      • ServiceRollbackFailureAction
      • ServiceRollbackOrder
      • ServiceSELinuxContext
      • ServiceSchedulingMode
      • ServiceSecret
      • ServiceSpec
      • ServiceTaskTemplate
      • ServiceTmpfsOptions
      • ServiceUpdateConfig
      • ServiceUpdateFailureAction
      • ServiceUpdateOrder
      • ServiceUpdateState
      • ServiceUpdateStatus
      • ServiceVersion
      • ServiceVirtualIP
      • ServiceVolumeDriverConfig
      • ServiceVolumeOptions
      • VolumeListResponse
    • Neon.GitHub
      • GitExtensions
      • GitHubCredentials
      • GitHubRepo
      • LocalRepoApi
      • NoLocalRepositoryException
      • RemoteRepoApi
      • RemoteRepoBranchApi
      • RemoteRepoIssueApi
      • RemoteRepoIssueCommentApi
      • RemoteRepoPath
      • RemoteRepoReleaseApi
      • RemoteRepoTagApi
    • Neon.HyperV
      • HyperVClient
      • HyperVDriverType
      • HyperVException
      • NetAdapter
      • VirtualDrive
      • VirtualIPAddress
      • VirtualMachine
      • VirtualMachineNetworkAdapter
      • VirtualMachineState
      • VirtualNat
      • VirtualSwitch
      • VirtualSwitchType
    • Neon.IO
      • BlockStream
      • FixedLengthStream
      • IStaticDirectory
      • IStaticFile
      • LineEnding
      • LinuxPath
      • LinuxPermissions
      • PreprocessReader
      • RelayStream
      • StaticDirectoryBase
      • StaticFileBase
      • SubStream
      • TempFile
      • TempFolder
    • Neon.JsonConverters
      • JsonDateTimeConverter
      • JsonGenericConverter<T>
      • JsonNullableDateTimeConverter
    • Neon.ModelGen
      • ActionResult<T>
      • ApiVersion
      • ApiVersionAttribute
      • BodyStreamAttribute
      • ControllerValidationAttribute
      • DataModelAttribute
      • EnumMember
      • FromBodyAttribute
      • FromHeaderAttribute
      • FromQueryAttribute
      • FromRouteAttribute
      • GeneratedClientAttribute
      • GeneratedMethodAttribute
      • GeneratedParamAttribute
      • HashSourceAttribute
      • HttpAttribute
      • HttpDeleteAttribute
      • HttpGetAttribute
      • HttpHeadAttribute
      • HttpOptionsAttribute
      • HttpPatchAttribute
      • HttpPostAttribute
      • HttpPutAttribute
      • IActionResult
      • ModelGenerator
      • ModelGeneratorOutput
      • ModelGeneratorSettings
      • NoCodeGenAttribute
      • NoControllerValidationAttribute
      • PassAs
      • PersistableAttribute
      • PersistableKeyAttribute
      • RouteAttribute
      • ServiceModelAttribute
      • TargetAttribute
      • UxFrameworks
    • Neon.Net
      • HttpApiException
      • HttpException
      • JsonClient
      • JsonClientPayload
      • JsonResponse
      • Jwt
      • LocalHostSection
      • NetConst
      • NetHelper
      • NetworkCidr
      • NetworkConfiguration
      • NetworkException
      • NetworkPorts
      • Pinger
      • ReachableHost
      • ReachableHostMode
      • StreamDocument
    • Neon.Postgres
      • ConnectionExtensions
      • DatabaseStatus
      • PreparedCommand
      • ReaderAsyncEnumerator
      • ReaderEnumerator
      • ReaderExtensions
      • SchemaManager
      • SchemaManagerException
      • SchemaStatus
    • Neon.Retry
      • ExponentialRetryPolicy
      • IRetryPolicy
      • LinearRetryPolicy
      • NoRetryPolicy
      • RetryPolicy
      • RetryPolicyBase
      • RetryTransientArgs
      • TransientDetector
      • TransientException
    • Neon.Roslyn
      • DisplayFormat
      • DocumentationComment
      • DocumentationItem
      • MetadataLoadContext
      • RoslynAssembly
      • RoslynConstructorInfo
      • RoslynCustomAttributeData
      • RoslynExtensions
      • RoslynFieldInfo
      • RoslynMethodInfo
      • RoslynParameterInfo
      • RoslynPropertyInfo
      • RoslynType
      • SharedUtilities
    • Neon.Roslyn.Xunit
      • AdditionalSourceText
      • CompilationOptions
      • CompilationOptionsProvider
      • TestCompilation
      • TestCompilationAssertions
      • TestCompilationBuilder
      • TestCompilationBuilderExtensions
      • TestCompilationExtensions
    • Neon.SSH
      • CommandBundle
      • CommandFile
      • CommandResponse
      • HostFolders
      • IBashCommandFormatter
      • ILinuxSshProxy
      • LinuxDiskInfo
      • LinuxDiskPartition
      • LinuxSshProxy
      • LinuxSshProxy<TMetadata>
      • NamespaceDoc
      • RemoteCommandException
      • RunOptions
      • SshCredentials
      • SshExtensions
      • SshProxyException
    • Neon.Service
      • LogMetricsProcessor
      • MetricsMode
      • MetricsOptions
      • NeonService
      • NeonServiceOptions
      • NeonServiceStatus
      • OtelConfigExtensions
      • OtlpCollectorChecker
      • ProcessTerminator
      • ServiceApiContact
      • ServiceApiInfo
      • ServiceApiLicense
      • ServiceDependencies
      • ServiceDescription
      • ServiceEndpoint
      • ServiceEndpointProtocol
      • ServiceEndpoints
      • ServiceMap
    • Neon.SignalR
      • DependencyInjectionExtensions
      • DnsCache
      • GroupAction
      • GroupCommand
      • IDnsCache
      • Invocation
      • NatsHubLifetimeManager<THub>
      • ProxyConfig
      • ServiceCollectionExtensions
      • ServiceDiscovey
      • SignalrProxyMiddleware
      • SignalrProxyMiddlewareExtensions
      • TracerProviderBuilderExtensions
    • Neon.Tailwind
      • ClickOffEventHandler
      • ComponentEventArgs<TSender>
      • ComponentEventArgs<TSender, TEventArgs>
      • DisclosureState
      • EventHandlerComponentBase<TComponent>
      • HeadlessButton
      • HeadlessDialog
      • HeadlessDialogPanel
      • HeadlessDisclosure
      • HeadlessDisclosureButton
      • HeadlessDisclosurePanel
      • HeadlessListboxButton<TValue>
      • HeadlessListboxLabel<TValue>
      • HeadlessListboxOption<TValue>
      • HeadlessListboxOptions<TValue>
      • HeadlessListbox<TValue>
      • HeadlessMenu
      • HeadlessMenuButton
      • HeadlessMenuItem
      • HeadlessMenuItems
      • HeadlessSwitch
      • HeadlessSwitchGroup
      • HeadlessSwitchLabel
      • IPortalBinder
      • KeyDownEventHandler
      • KeyboardKey
      • ListboxFocus
      • ListboxState
      • MenuFocus
      • MenuState
      • Portal
      • PortalBinder
      • PortalContent
      • SearchAssistant
      • TailwindExtensions
      • Transition
      • TransitionGroup
      • TransitionState
    • Neon.Tasks
      • Async
      • AsyncAutoResetEvent
      • AsyncManualResetEvent
      • AsyncMutex
      • AsyncPeriodicTask
      • AsyncReaderWriterLock
      • AsyncReentrantMutex
      • AsyncTimer
      • IAsyncFuture
      • IAsyncFuture<T>
      • NonDisposableTask
      • NonDisposableTask<T>
      • SyncContext
      • SyncContextMode
    • Neon.Temporal
      • ActivityHelper
      • ActivityLogEnricher
      • TemporalEnricherTagNames
      • WorkflowLogEnricher
    • Neon.Time
      • GatedTimer
      • GoDuration
      • PolledTimer
      • RecurringTimer
      • RecurringTimerType
      • SysTime
      • TimeOfDay
    • Neon.WSL
      • Wsl2Proxy
    • Neon.Web
      • AesProtector
      • DataProtectionExtensions
      • NeonController
      • NeonControllerBase
      • RoundTripJsonInputFormatter
      • RoundTripJsonOutputFormatter
      • TracerProviderBuilderExtensions
      • WebHelper
    • Neon.WinTTY
      • ConsoleTTY
    • Neon.Windows
      • MEMORYSTATUSEX
      • PowerShellException
      • Win32
    • Neon.XenServer
      • IXenClient
      • XenClient
      • XenClient.MachineOperations
      • XenClient.StorageOperations
      • XenClient.TemplateOperations
      • XenException
      • XenHostInfo
      • XenObject
      • XenResponse
      • XenStorageRepository
      • XenTempIso
      • XenTemplate
      • XenVirtualDisk
      • XenVirtualMachine
      • XenVmPowerState
    • Neon.Xunit
      • AnsiblePlayResults
      • AnsiblePlayer
      • AnsibleTaskResult
      • AspNetFixture
      • BasicFixture
      • CodeFixture
      • CollectionComparer<T>
      • ComposedFixture
      • ContainerFixture
      • ContainerLimits
      • DockerComposeFixture
      • DockerFixture
      • DockerFixture.ConfigInfo
      • DockerFixture.ContainerInfo
      • DockerFixture.NetworkInfo
      • DockerFixture.SecretInfo
      • DockerFixture.ServiceInfo
      • DockerFixture.StackDefinition
      • DockerFixture.StackInfo
      • DockerFixture.StackService
      • EnvironmentFixture
      • HostsFixture
      • ITestFixture
      • IncompatibleServiceException
      • MaintainerFactAttribute
      • MaintainerTheoryAttribute
      • MockHttpServer
      • MockHttpServerExtensions
      • NatsFixture
      • NatsStreamingFixture
      • NeonServiceFixture<TService>
      • PlatformFactAttribute
      • RepeatAttribute
      • TargetPlatforms
      • TestArea
      • TestCollection
      • TestContext
      • TestFixture
      • TestFixtureStatus
      • TestHelper
      • TestHttpClient
      • TestOutputWriter
      • TestTrait
      • XunitExtensions
    • Neon.Xunit.YugaByte
      • YugaByteFixture
    • Neon.YugaByte
      • YugaByteHelper

    Class RemoteRepoReleaseApi

    Implements the friendly GitHub repository release related APIs.

    Inheritance
    object
    RemoteRepoReleaseApi
    Namespace: Neon.GitHub
    Assembly: Neon.GitHub.dll
    Syntax
    public class RemoteRepoReleaseApi

    Methods

    AddAssetAsync(Release, Stream, string, string)

    Uploads an asset stream to a GitHub release. Any existing asset with same name will be replaced.

    note

    This only works for unpublished releases where Draft=true.

    Declaration
    public Task<ReleaseAsset> AddAssetAsync(Release release, Stream stream, string assetName, string contentType = "application/octet-stream")
    Parameters
    Type Name Description
    Release release

    The target release.

    Stream stream

    The asset source stream.

    string assetName

    Specifies the file name to assign to the asset.

    string contentType

    Optionally specifies the asset's Content-Type. This defaults to: application/octet-stream

    Returns
    Type Description
    Task<ReleaseAsset>

    The new Octokit.ReleaseAsset.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    AddAssetAsync(Release, string, string, string)

    Uploads an asset file to a GitHub release. Any existing asset with same name will be replaced.

    note

    This only works for unpublished releases where Draft=true.

    Declaration
    public Task<ReleaseAsset> AddAssetAsync(Release release, string assetPath, string assetName = null, string contentType = "application/octet-stream")
    Parameters
    Type Name Description
    Release release

    The target release.

    string assetPath

    Path to the source asset file.

    string assetName

    Optionally specifies the file name to assign to the asset. This defaults to the file name in assetPath.

    string contentType

    Optionally specifies the asset's Content-Type. This defaults to: application/octet-stream

    Returns
    Type Description
    Task<ReleaseAsset>

    The new Octokit.ReleaseAsset.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    NotSupportedException

    Thrown when the releas has already been published.

    AddMultipartAssetAsync(Release, string, string, string, string, bool, long)

    Uploads a multi-part download to a release as an asset and then publishes the release.

    Declaration
    public Task<DownloadManifest> AddMultipartAssetAsync(Release release, string sourcePath, string version, string name = null, string filename = null, bool noMd5File = false, long maxPartSize = 78643200)
    Parameters
    Type Name Description
    Release release

    The target release.

    string sourcePath

    Path to the file being uploaded.

    string version

    The download version.

    string name

    Optionally overrides the download file name specified by sourcePath to initialize Name.

    string filename

    Optionally overrides the download file name specified by sourcePath to initialize Filename.

    bool noMd5File

    This method creates a file named [sourcePath.md5] with the MD5 hash for the entire uploaded file by default. You may override this behavior by passing noMd5File=true.

    long maxPartSize

    Optionally overrides the maximum part size (defaults to 75 MiB).

    Returns
    Type Description
    Task<DownloadManifest>

    The DownloadManifest.

    Remarks

    The release passed must be unpublished and you may upload other assets before calling this.

    note

    Take care that any assets already published have names that won't conflict with the asset part names, which will be formatted like: part-##

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    CreateAsync(string, string, string, bool, bool)

    Creates a GitHub release.

    Declaration
    public Task<Release> CreateAsync(string tagName, string releaseName = null, string body = null, bool draft = false, bool prerelease = false)
    Parameters
    Type Name Description
    string tagName

    Specifies the release name.

    string releaseName

    Optionally specifies the release name (defaults to tagName).

    string body

    Optionally specifies the markdown formatted release notes.

    bool draft

    Optionally indicates that the release won't be published immediately.

    bool prerelease

    Optionally indicates that the release is not production ready.

    Returns
    Type Description
    Task<Release>

    The new release.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    DeleteAsync(string)

    Removes a GitHub release by name, if it exists.

    note

    It's possible to have multiple releases with the same name. This method will remove all of them.

    Declaration
    public Task<bool> DeleteAsync(string releaseName)
    Parameters
    Type Name Description
    string releaseName

    Specifies the release name.

    Returns
    Type Description
    Task<bool>

    true when one or more releases were removed, false otherwise.

    DownloadZipballAsync(string, Stream)

    Returns the zipped source code (Zipball) for a published release.

    note

    The repository files in the Zipball are are persisted to a root folder named like REPONAME-COMMIT where REPONAME is the name of the GitHub repository and COMMIT is the latest commit for the repo.

    Declaration
    public Task DownloadZipballAsync(string releaseName, Stream output)
    Parameters
    Type Name Description
    string releaseName

    Specifies the release name.

    Stream output

    Specifies the stream where the Zipball will be written.

    Returns
    Type Description
    Task

    The tracking Task.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    InvalidOperationException

    Thrown if the release does not exist or it has not been published.

    FindAsync(string)

    Searches for a specific GitHub origin repository release.

    Declaration
    public Task<Release> FindAsync(string releaseName)
    Parameters
    Type Name Description
    string releaseName

    Specifies the origin repository release name.

    Returns
    Type Description
    Task<Release>

    The requested Octokit.Release or null when it doesn't exist.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    GetAllAsync()

    Returns all releases from the GitHub origin repository.

    Declaration
    public Task<IReadOnlyList<Release>> GetAllAsync()
    Returns
    Type Description
    Task<IReadOnlyList<Release>>

    The list of releases.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    GetAssetUri(Release, ReleaseAsset)

    Returns the URI that can be used to download a GitHub release asset.

    note

    This works only for published releases.

    Declaration
    public string GetAssetUri(Release release, ReleaseAsset asset)
    Parameters
    Type Name Description
    Release release

    The target release.

    ReleaseAsset asset

    The target asset.

    Returns
    Type Description
    string

    The asset URI.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    InvalidOperationException

    Thrown when the asset passed doesn't exist in the release.

    GetAsync(string)

    Returns a specific GitHub origin repository release.

    Declaration
    public Task<Release> GetAsync(string releaseName)
    Parameters
    Type Name Description
    string releaseName

    Specifies the origin repository release name.

    Returns
    Type Description
    Task<Release>

    The requested Octokit.Release.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    NotFoundException

    Thrown when the release does not exist.

    GetZipballUri(string)

    Returns the URI for the zipped source code (Zipball) for a published release.

    Declaration
    public Task<string> GetZipballUri(string releaseName)
    Parameters
    Type Name Description
    string releaseName

    Specifies the release name.

    Returns
    Type Description
    Task<string>

    The zipball URI.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    InvalidOperationException

    Thrown if the release does not exist or it has not been published.

    PublishAsync(string)

    Publishes a release.

    Declaration
    public Task<Release> PublishAsync(string releaseName)
    Parameters
    Type Name Description
    string releaseName

    Specifies the release name.

    Returns
    Type Description
    Task<Release>

    The published release.

    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    InvalidOperationException

    Thrown if the release doesn't exist or when it's already published.

    RefreshAsync(Release)

    Returns the latest version of a release.

    Declaration
    public Task<Release> RefreshAsync(Release release)
    Parameters
    Type Name Description
    Release release

    The release being refreshed.

    Returns
    Type Description
    Task<Release>

    The updated release.

    Exceptions
    Type Condition
    InvalidOperationException

    Thrown when the relase no longer exists.

    UpdateAsync(Release, ReleaseUpdate)

    Updates an existing GitHub release.

    Declaration
    public Task<Release> UpdateAsync(Release release, ReleaseUpdate releaseUpdate)
    Parameters
    Type Name Description
    Release release

    Specifies the release being changed.

    ReleaseUpdate releaseUpdate

    Specifies the release revisions.

    Returns
    Type Description
    Task<Release>

    The updated release.

    Remarks

    To update a release, you'll first need to:

    1. Create a new release or get and existing one.
    2. Obtain a Octokit.ReleaseUpdate by calling Octokit.Release.ToUpdate().
    3. Make your changes to the release update.
    4. Call UpdateAsync(Release, ReleaseUpdate), passing the original release along with the update.
    Exceptions
    Type Condition
    ObjectDisposedException

    Thrown when the GitHubRepo has been disposed.

    In this article
    Back to top © Copyright 2005-2023 by NEONFORGE LLC