The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

HockeyApp Plugin

hockeyApp: Upload to HockeyApp

  • applications
    A list of applications that will be uploaded to HockeyApp
      Array/List
      Nested Object
    • apiToken
      Your HockeyApp API Token.
      Can be generated in your HockeyApp account settings.
      You need to create a token with full access if you mark your releases as be available for download as soon as they're uploaded.
      When left undefined and a global API Token is defined, the latter one is used.
      • Type: String
    • appId
      • Type: String
    • notifyTeam
      Enable if you want HockeyApp to notify your team about each uploaded version.
      • Type: boolean
    • filePath
      The path, relative to the build's workspace, to the generated .ipa (iOS), .app.zip (MacOS), or .apk (Android) file.
      You can include build variables here like ${BUILD_NUMBER} and they'll be expanded at build time.

      e.g. "MyApp/build/Beta-iphoneos/MyApp-Beta-${BUILD_NUMBER}.ipa if your use ${BUILD_NUMBER} as technical version number (CFBundleShortVersionString).

      Can use wildcards like 'module/dist/**/*.ipa'. See the @includes of Ant fileset for the exact format.
      • Type: String
    • dsymPath
      An optional path, relative to the build's workspace, to the generated dSYM.zip (iOS and MacOS) or mapping.txt (Android) file.
      You can include build variables here like ${BUILD_NUMBER} and they'll be expanded at build time.

      e.g. "MyApp/build/Beta-iphoneos/MyApp-Beta-${BUILD_NUMBER}.dsym.zip if your use ${BUILD_NUMBER} as technical version number (CFBundleShortVersionString).
      Can use wildcards like 'module/dist/**/*.dSYM.zip'. See the @includes of Ant fileset for the exact format.
      Further information on symbolicate a crash can be found here.
      • Type: String
    • libsPath
      Optional path, relative to the build's workspace, to an archive with generated .so files. This archive must have the following structure: ${ARCHITECTURE}/*.so
      You can include build variables here like ${BUILD_NUMBER} and they'll be expanded at build time.

      e.g. "MyApp/build/Beta-android/MyApp-Beta-${BUILD_NUMBER}.zip if your use ${BUILD_NUMBER} as technical version number.

      Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
      • Type: String
    • tags
      By entering a comma-separated list of tags here, you can restrict downloads of your app to only users/devices with these tags.
      You can include build variables here like ${BUILD_NUMBER} and they'll be expanded at build time.
      If this field is blank, no such restrictions will be applied to the uploaded app.
      • Type: String
    • teams
      Restrict download to comma-separated list of team IDs
      If this field is blank, no such restrictions will be applied to the uploaded app.
      • Type: String
    • mandatory
      Enable if you want the upload to be a mandatory version.
      • Type: boolean
    • downloadAllowed
      Enable if you want new versions to be available for download and installation immediately, without having to enable this manually in HockeyApp.
      • Type: boolean
    • oldVersionHolder
        Nested Object
      • numberOldVersions
        • Type: String
      • sortOldVersions
        • Type: String
      • strategyOldVersions
        • Type: String
    • releaseNotesMethod
        Nested Choice of Objects
      • appCreation
        • publicPage
          • Type: boolean
      • changelog
        • file
          • fileName
            The path, relative to the build's workspace to the file that provides the release notes.
            • Type: String
          • isMarkdown
            If checked HockeyApp expectes the provided Release notes to be written in Markdown.
            • Type: boolean
        • manual
          • releaseNotes
            Release notes to be shown to users on HockeyApp, in Textile format.
            You can include build variables here like ${BUILD_NUMBER} and they'll be expanded at build time.
            • Type: String
          • isMarkdown
            If checked HockeyApp expectes the provided Release notes to be written in Markdown.
            • Type: boolean
        • none
          • versionCreation
        • uploadMethod
            Nested Choice of Objects
          • appCreation
            • publicPage
              • Type: boolean
          • changelog
            • file
              • fileName
                The path, relative to the build's workspace to the file that provides the release notes.
                • Type: String
              • isMarkdown
                If checked HockeyApp expectes the provided Release notes to be written in Markdown.
                • Type: boolean
            • manual
              • releaseNotes
                Release notes to be shown to users on HockeyApp, in Textile format.
                You can include build variables here like ${BUILD_NUMBER} and they'll be expanded at build time.
                • Type: String
              • isMarkdown
                If checked HockeyApp expectes the provided Release notes to be written in Markdown.
                • Type: boolean
            • none
              • versionCreation
          • debugMode
            Enables debug mode.
            Currently its purpose is to enable printing response on every request (not only erroneous ones).
            • Type: boolean
          • baseUrlHolder
              Nested Object
            • baseUrl
              • Type: String
          • failGracefully
            If the upload to HockeyApp fails, the build is not marked as failed once fail gracefully is enabled.
            • Type: boolean

          Was this page helpful?

          Please submit your feedback about this page through this quick form.

          Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

              


          See existing feedback here.