Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 2.74 KB

readme.md

File metadata and controls

36 lines (23 loc) · 2.74 KB

Cake.OctoDeploy

Build status NuGet Coverage Status

An addin for Cake that allows for the easy creation of GitHub releases with or without assets

#addin nuget:?package=Cake.OctoDeploy

Methods

The following methods are provided:

  • PublishRelease(this ICakeContext context, string tag, string releaseTitle, string releaseNotes, bool draftRelease, bool preRelease, OctoDeploySettings octoDeploySettings)
  • PublishRelease(this ICakeContext context, string tag, string releaseTitle, FilePath releaseNotesFilePath, bool draftRelease, bool preRelease, OctoDeploySettings octoDeploySettings)

Publish a release on GitHub

  • PublishReleaseWithArtifact(this ICakeContext context, string tag, string releaseTitle, string releaseNotes, bool draftRelease, bool preRelease, FilePath artifactPath, string artifactName, string artifactMimeType, OctoDeploySettings octoDeploySettings)
  • PublishReleaseWithArtifact(this ICakeContext context, string tag, string releaseTitle, FilePath releaseNotesFilePath, bool draftRelease, bool preRelease, FilePath artifactPath, string artifactName, string artifactMimeType, OctoDeploySettings octoDeploySettings)

Publish a release with an artifact

  • PublishReleaseWithArtifacts(this ICakeContext context, string tag, string releaseTitle, string releaseNotes, bool draftRelease, bool preRelease, FilePath[] artifactPaths, string[] artifactNames, string[] artifactMimeTypes, OctoDeploySettings octoDeploySettings)
  • PublishReleaseWithArtifacts(this ICakeContext context, string tag, string releaseTitle, FilePath releaseNotesFilePath, bool draftRelease, bool preRelease, FilePath[] artifactPaths, string[] artifactNames, string[] artifactMimeTypes, OctoDeploySettings octoDeploySettings)

Publish a release with an artifact. Note that the artifact paths and their respective names need to be in the same order in their respective arrays otherwise they will end up incorrectly named

  • UploadArtifact(this ICakeContext context, int releaseId, FilePath artifactPath, string artifactName, string artifactMimeType, OctoDeploySettings octoDeploySettings)

Upload an artifact to an existing release

Icon

Github by Doejo from The Noun Project, remixed with the Cake icon.