Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

110 lines (78 loc) · 3.51 KB

Contributing

Building the Plugin

./gradlew clean build

Jar files are generated into build/libs.

Installing Locally

Install the plugin to your local Maven repository:

./gradlew clean install

Add mavenLocal to your buildscript repositories:

buildscript {
    repositories {
        mavenLocal()
    }
}

If you need to remove the plugin, run the following command then perform a clean build:

rm ~/.m2/repository/com/bugsnag/bugsnag-android-gradle-plugin

Releasing a New Version

Release Checklist

Please follow the testing instructions in the platforms release checklist, and any additional steps directly below.

  • Trigger a New Build in Buildkite on the target branch, and verify that the private scenarios pass.

  • Use gradlew clean install to install a release build to a local maven repo, and gradlew clean build to refresh the example project.

Instructions

If you are a project maintainer, you can build and release a new version of bugsnag-android-gradle-plugin as follows:

0. One-time setup

  • Create a file ~/.gradle/gradle.properties with the following contents:

    # Your credentials for https://oss.sonatype.org/
nexusUsername=your-nexus-username
nexusPassword=your-nexus-password

# GPG key details
signing.keyId=your-gpg-key-id # From gpg --list-keys
signing.password=your-gpg-key-passphrase
signing.secretKeyRingFile=/Users/james/.gnupg/secring.gpg

# Your credentials for https://bintray.com
bintray_user=your-bintray-username
bintray_api_key=your-bintray-api-key

  • Get the API key from James and add it to your Gradle configuration

1. Prepare for release

  • Update the CHANGELOG and README.md with any new features
  • Run make VERSION={version_number} bump to update the version number
  • Inspect the changes, confirm that the changeset behaves as expected
  • Run make VERSION={version_number} release to publish the release. Press return after running the command to kick off the build.

2. Upload the jar to the GitHub releases page

3. Release to jCenter and Maven Central

  • "Promote" the release build on Maven Central

    • Go to the sonatype open source dashboard
    • Click “Staging Repositories”
    • Click the search box at the top right, and type “com.bugsnag”
    • Select the com.bugsnag staging repository
    • Click the “close” button in the toolbar, no message
    • Click the “refresh” button
    • Select the com.bugsnag closed repository
    • Click the “release” button in the toolbar

  • Confirm the release on Bintray

4. Update docs.bugsnag.com

Update the setup guide for Java (Android) with any new content.