Cleanup before 1.0 release

This commit is contained in:
Erik C. Thauvin 2023-09-25 17:06:45 -07:00
parent f6f3c82513
commit b7aee90edd
8 changed files with 37 additions and 13 deletions

View file

@ -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

View file

@ -0,0 +1 @@
future-release=1.0.0

19
CHANGELOG.md Normal file
View file

@ -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)*

View file

@ -26,7 +26,6 @@ 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.
### JSON or XML
The [is.gd API](https://is.gd/developers.php) can return data in plain text (default), 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,6 +100,7 @@ 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:

View file

@ -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 {

View file

@ -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>

View file

@ -1,5 +1,5 @@
plugins {
id("com.gradle.enterprise").version("3.6.3")
id("com.gradle.enterprise").version("3.15")
}
gradleEnterprise {

View file

@ -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