Cleanup before 1.0 release

ethauvin · Sep 26, 2023 · b7aee90 · b7aee90
1 parent f6f3c82
commit b7aee90
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 13 deletions.
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -39,7 +39,7 @@ jobs:
       - name: Test with Gradle
         uses: gradle/gradle-build-action@v2
         with:
-          arguments: build check --stacktrace
+          arguments: build check --stacktrace --scan
 
       - name: SonarCloud
         if: success() && matrix.java-version == env.SONAR_JDK

diff --git a/.github_changelog_generator b/.github_changelog_generator
@@ -0,0 +1 @@
+future-release=1.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,19 @@
+# Changelog
+
+## [1.0.0](https://github.com/ethauvin/isgd-shorten/tree/1.0.0) (2023-09-25)
+
+[Full Changelog](https://github.com/ethauvin/isgd-shorten/compare/0.9.1...1.0.0)
+
+**Implemented enhancements:**
+
+- Add config builder [\#3](https://github.com/ethauvin/isgd-shorten/issues/3)
+- Use UrlEncoder instead of java.net.URLEncoder [\#2](https://github.com/ethauvin/isgd-shorten/issues/2)
+- Implement a way to retrieve the error response message. [\#1](https://github.com/ethauvin/isgd-shorten/issues/1)
+
+## [0.9.1](https://github.com/ethauvin/isgd-shorten/tree/0.9.1) (2020-06-10)
+
+[Full Changelog](https://github.com/ethauvin/isgd-shorten/compare/60c449feed0ddced600d7135766243e7058d683a...0.9.1)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
diff --git a/README.md b/README.md
@@ -24,8 +24,7 @@ Isgd.lookup("https://is.gd/Pt2sET") // returns https://www.example.com
 
 ```
 
- - View [Kotlin](https://github.com/ethauvin/isgd-shorten/blob/master/examples/src/main/kotlin/com/example/IsgdExample.kt) or [Java](https://github.com/ethauvin/isgd-shorten/blob/master/examples/src/main/java/com/example/IsgdSample.java) Examples.
-
+- View [Kotlin](https://github.com/ethauvin/isgd-shorten/blob/master/examples/src/main/kotlin/com/example/IsgdExample.kt) or [Java](https://github.com/ethauvin/isgd-shorten/blob/master/examples/src/main/java/com/example/IsgdSample.java) Examples.
 
 ### JSON or XML
 
@@ -53,11 +52,13 @@ Isgd.shorten(
     logstats = true,
     format = Format.JSON)
 ```
+
 returns:
 
 ```js
 test({ "shorturl": "https://is.gd/foobar" });
 ```
+
 ### Gradle
 
 To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/isgd-shorten/blob/master/examples/build.gradle.kts) file:
@@ -69,9 +70,10 @@ repositories {
 }
 
 dependencies {
-    implementation("net.thauvin.erik:isgd-shorten:0.9.2")
+    implementation("net.thauvin.erik:isgd-shorten:1.0.0")
 }
 ```
+
 Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://central.sonatype.com/artifact/net.thauvin.erik/isgd-shorten).
 
 ## Java
@@ -89,6 +91,7 @@ var config = new Config.Builder()
 
 Isgd.shorten(config);
 ```
+
 ```java
 var config = new Config.Builder()
         .shortUrl("https://is.gd/Pt2sET")
@@ -97,9 +100,10 @@ var config = new Config.Builder()
 
 Isgd.lookup(config);
 ```
+
 ### Errors
 
-An `IsgdException` is thrown when an API error occurs. The error message (text, XML or JSON) and HTTP status code can be retrieved as follows: 
+An `IsgdException` is thrown when an API error occurs. The error message (text, XML or JSON) and HTTP status code can be retrieved as follows:
 
 ```kotlin
 try {

diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts
@@ -16,7 +16,7 @@ repositories {
 }
 
 dependencies {
-    implementation("net.thauvin.erik:isgd-shorten:0.9.2-SNAPSHOT")
+    implementation("net.thauvin.erik:isgd-shorten:1.0.0")
 }
 
 java {

diff --git a/pom.xml b/pom.xml
@@ -8,7 +8,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>net.thauvin.erik</groupId>
   <artifactId>isgd-shorten</artifactId>
-  <version>0.9.2-SNAPSHOT</version>
+  <version>1.0.0</version>
   <name>isgd-shorten</name>
   <description>A simple implementation of the is.gd URL shortening and lookup APIs</description>
   <url>https://github.com/ethauvin/isgd-shorten</url>

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,5 +1,5 @@
 plugins {
-  id("com.gradle.enterprise").version("3.6.3")
+  id("com.gradle.enterprise").version("3.15")
 }
 
 gradleEnterprise {

diff --git a/version.properties b/version.properties
@@ -1,8 +1,8 @@
 #Generated by the Semver Plugin for Gradle
 #Sun May 02 21:57:08 PDT 2021
 version.buildmeta=
-version.major=0
-version.minor=9
-version.patch=2
-version.prerelease=SNAPSHOT
-version.semver=0.9.2-SNAPSHOT
+version.major=1
+version.minor=0
+version.patch=0
+version.prerelease=
+version.semver=1.0.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,7 +16,7 @@ repositories { @@
     }
     dependencies {
-        implementation("net.thauvin.erik:isgd-shorten:0.9.2-SNAPSHOT")
+        implementation("net.thauvin.erik:isgd-shorten:1.0.0")
     }
     java {
@@ Expand Down @@