Summary
Contains functionality related to HockeyApp.
It allows you to upload an app package to HockeyApp with just one line of code. In order to use the exposed commands you have to add the following line at top of your build.cake file.
#addin Cake.HockeyApp
- Assembly
- Cake
.HockeyApp .dll - Namespace
- Cake
.HockeyApp - Base Types
-
- Object
Syntax
public static class HockeyAppAliases
Examples
Upload an apk to HockeyApp:
Task("Upload-To-HockeyApp")
.IsDependentOn("Build-APK")
.Does(() => UploadToHockeyApp("./output/myApp.apk"));
Upload an apk to HockeyApp with result.
Task("Upload-To-HockeyApp")
.IsDependentOn("Build-APK")
.Does(() =>
{
var result = UploadToHockeyApp("./output/myApp.apk"));
// Use result.PublicUrl to inform others where they can download the newly uploaded package.
}
Upload a Windows package.
Unfortunately, HockeyApp currently does only support metadata discovering for Android, iOS and macOS packages. Therefore you have to specify a version AND app id your self. This means that you have to create the app once before uploading. Create new App. Creating a new version is automatically done by this addin.
Task("Upload-To-HockeyApp")
.IsDependentOn("Build-AppX")
.Does(() =>
{
UploadToHockeyApp( "./output/myWindowsApp.appx", new HockeyAppUploadSettings
{
AppId = appIdFromHockeyApp,
Version = "1.0.160901.1",
ShortVersion = "1.0-beta2",
Notes = "Uploaded via continuous integration."
});
}
For all request you make you either have to set your API token from HockeyApp as environment variable: HOCKEYAPP_API_TOKEN
or pass it into the call via AppId
Attributes
Type | Description |
---|---|
Cake |
Fields
Name | Constant Value | Summary |
---|---|---|
TokenVariable | HOCKEYAPP_API_TOKEN |
static
|
Methods
Name | Value | Summary |
---|---|---|
Update |
Hockey |
Update the attributes of an existing version.
Version property of
HockeyAppUploadSettings
static
|
UploadToHockeyApp |
Hockey |
Uploads the specified package to HockeyApp. Currently it is required to specify the AppId and the
Version property of
HockeyAppUploadSettings
static
|
UploadToHockeyApp |
Hockey |
Uploads the specified package and symbols file to HockeyApp. The version is automatically detected from the package metadata.
This only works with *.ipa for iOS, *.app.zip for OS X, or *.apk files for Android.
static
|
UploadToHockeyApp |
void |
static
|
UploadToHockeyApp |
Hockey |
Uploads the specified package to HockeyApp. If you don't upload an apk or ipa, it is required to specify the AppId and the
Version property of
HockeyAppUploadSettings .
static
|
UploadToHockeyApp |
Hockey |
Uploads the specified package and symbols file to HockeyApp. The version is automatically detected from the package metadata.
This only works with *.ipa for iOS, *.app.zip for OS X, or *.apk files for Android.
static
|
Extension Methods
Name | Value | Summary |
---|---|---|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|