add docs for v4.17.0

bugsnag · Jul 18, 2019 · 24c2fd6 · 24c2fd6
1 parent cbd480d
commit 24c2fd6
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog
 
+## 4.17.0 (2019-07-17)
+
+This release modularizes `bugsnag-android` into 3 separate artifacts: for JVM, NDK, and ANR error
+detection. No change should be required to your integration in order to use this version - simply
+add a compile-time dependency on either `bugsnag-android` or `bugsnag-android-ndk` as before.
+
+If you do not wish to use the NDK/ANR artifacts, it is possible to exclude these via gradle. You
+should also set `detectNdkCrashes` and `detectAnrs` to false on the `Configuration` object supplied
+during `Bugsnag.init()`.
+
+```groovy
+implementation("com.bugsnag:bugsnag-android:$version") {
+    exclude group: "com.bugsnag", module: "bugsnag-plugin-android-anr"
+    exclude group: "com.bugsnag", module: "bugsnag-plugin-android-ndk"
+}
+```
+
+* Modularise bugsnag-android into JVM, NDK, and ANR artifacts
+  [#522](https://github.com/bugsnag/bugsnag-android/pull/522)
+
 ## 4.16.1 (2019-07-10)
 
 ### Bug fixes

diff --git a/Makefile b/Makefile
@@ -3,13 +3,13 @@ all: build
 .PHONY: build test clean bump release
 
 build:
-	./gradlew sdk:build
+	./gradlew build
 
 clean:
 	./gradlew clean
 
 test:
-	./gradlew :sdk:connectedCheck
+	./gradlew connectedCheck
 
 remote-test:
 ifeq ($(BROWSER_STACK_USERNAME),)
@@ -48,7 +48,7 @@ endif
 	@echo Bumping the version number to $(VERSION)
 	@sed -i '' "s/VERSION_NAME=.*/VERSION_NAME=$(VERSION)/" gradle.properties
 	@sed -i '' "s/NOTIFIER_VERSION = .*;/NOTIFIER_VERSION = \"$(VERSION)\";/"\
-	 sdk/src/main/java/com/bugsnag/android/Notifier.java
+	 bugsnag-android-core/src/main/java/com/bugsnag/android/Notifier.java
 	@sed -i '' "s/## TBD/## $(VERSION) ($(shell date '+%Y-%m-%d'))/" CHANGELOG.md
 
 # Makes a release
@@ -59,8 +59,8 @@ endif
 ifeq ($(VERSION),)
 	@$(error VERSION is not defined. Run with `make VERSION=number release`)
 endif
-	@git add -p CHANGELOG.md README.md gradle.properties sdk/src/main/java/com/bugsnag/android/Notifier.java
+	@git add -p CHANGELOG.md README.md gradle.properties bugsnag-android-core/src/main/java/com/bugsnag/android/Notifier.java
 	@git commit -m "Release v$(VERSION)"
 	@git tag v$(VERSION)
 	@git push origin master v$(VERSION)
-	@./gradlew sdk:assembleRelease publish bintrayUpload && ./gradlew sdk:assembleRelease publish bintrayUpload -PreleaseNdkArtefact=true
+	@./gradlew assembleRelease publish bintrayUpload && ./gradlew assembleRelease publish bintrayUpload -PreleaseNdkArtefact=true
diff --git a/bugsnag-android-core/src/main/java/com/bugsnag/android/Notifier.java b/bugsnag-android-core/src/main/java/com/bugsnag/android/Notifier.java
@@ -10,7 +10,7 @@
 public class Notifier implements JsonStream.Streamable {
 
     private static final String NOTIFIER_NAME = "Android Bugsnag Notifier";
-    private static final String NOTIFIER_VERSION = "4.16.1";
+    private static final String NOTIFIER_VERSION = "4.17.0";
     private static final String NOTIFIER_URL = "https://bugsnag.com";
 
     @NonNull

diff --git a/gradle.properties b/gradle.properties
@@ -11,7 +11,7 @@ org.gradle.jvmargs=-Xmx1536m
 # This option should only be used with decoupled projects. More details, visit
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
-VERSION_NAME=4.16.1
+VERSION_NAME=4.17.0
 GROUP=com.bugsnag
 POM_SCM_URL=https://github.com/bugsnag/bugsnag-android
 POM_SCM_CONNECTION=scm:[email protected]:bugsnag/bugsnag-android.git