Page is loading, just a sec...
  • Add debugg.it dependency to your project:
    • Add these lines to your app/build.gradle file:
      repositories {
          jcenter()
      }
      
      dependencies {
          implementation 'com.mooduplabs:debuggit:{latest-version}'
      }
      
    • Replace {latest-version} with newest version. You can find newest releases here
    • Sync your gradle files
  • Create class which extends Application class
    • Add application name into your AndroidManifest.xml file
      <manifest … >
      
        <uses-permission … />
        <uses-permission … />
      
        <application
          android:name=".MyApplication"
          … >
            <activity … />
            <activity … />
         </application>
      </manifest>
    • Add these permissions to AndroidManifest.xml file
      <uses-permission android:name="android.permission.INTERNET" />
    • Configure and init debugg.it in Application class onCreate() method:
      • Configure service for issues (use one of the following):
        • DebuggIt.getInstance().configureBitbucket("repoName", "ownerName");
        • DebuggIt.getInstance().configureGitHub("repoName", "ownerName");
        • DebuggIt.getInstance().configureJira("host", "projectKey");
        • If your host don't use SSL use this method:
          DebuggIt.getInstance().configureJira("host", "projectKey", false);
      • Configure an API where debugg.it can send image files and (optionally) audio files. There are 3 available configurations:
        • This configuration uses your AWS S3 bucket (https://aws.amazon.com/s3/") to store image and audio files.
        • DebuggIt.getInstance().configureS3Bucket("bucketName", "accessKey", "secretKey", "region");
        • We recommend that you create a separate user for debugg.it via AWS Identity and Access Management (IAM) with Read and Write Access to your S3 bucket.
        • This configuration uses your backend to send image and audio files.
        • DebuggIt.getInstance().configureDefaultApi("baseUrl", "uploadImageEndpoint", "uploadAudioEndpoint");
        • This is an extension of default API configuration. The difference is that you have to handle uploadImage / uploadAudio request and response. You are responsible for communication with your backend, but at the same time you have full control over it.
        • DebuggIt.getInstance().configureCustomApi(apiInterface);
      • After all configurations steps above are done, call at the end:
        DebuggIt.getInstance().init();
  • Add these methods in your Activity classes (preferably just in base activity class):
      • Add this method to onStart() method of your activities:
        DebuggIt.getInstance().attach(this);
      • Add this method to onActivityResult() method of your activities:
        DebuggIt.getInstance().getScreenshotPermission(requestCode, resultCode, data);

    Additional options: Record notes

    • debugg.it allows to record audio notes and add it to bug description.
      To enable this feature simply add this line in your Application class
    • DebuggIt.getInstance().setRecordingEnabled(true);
    • Ensure you have added RECORD_AUDIO permission in AndroidManifest.xml file:
      <uses-permission android:name="android.permission.RECORD_AUDIO" />

    “Loving debugg.it, it’s a very flexible great project! Easy-to-use testing environment makes everyone a QA expert. Now in VYDA we report bugs with screenshots and annotations in just few taps. Highly recommend.”

    photo

    Agnes Barath

    QA Specialist at VYDA