Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for v0.21.0 #757

Merged
merged 2 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,37 @@ Use the following schema when setting up the Changelog for a new release. Remove
### Security
-->

## [0.21.0] - 2024-11-06

In this release we have added a `uri` method to the `FileDescriptor` data type. The `uri` method can be used to produce
a `java.net.URI` from a `FileDescriptor`.

```scala
import com.kevel.apso.io._

val localFD = FileDescriptor("file:///tmp/one/two/three")
localFD.uri
// Returns java.net.URI = file:///tmp/one/two/three

val s3FD = FileDescriptor("s3://my-bucket/key")
s3FD.uri
// Returns java.net.URI = s3://my-bucket/key
```

### Added
- Add a `uri` method to `FileDescriptor` ([#756](https://github.com/adzerk/apso/pull/756)).

### Changed
- Update aws-java-sdk-core, aws-java-sdk-s3 to 1.12.776 ([#749](https://github.com/adzerk/apso/pull/749)).
- Update sbt, scripted-plugin to 1.10.3 ([#750](https://github.com/adzerk/apso/pull/750)).
- Update aws-java-sdk-s3 to 1.12.777 ([#751](https://github.com/adzerk/apso/pull/751)).
- Update sbt, scripted-plugin to 1.10.4 ([#752](https://github.com/adzerk/apso/pull/752)).
- Update bcpkix-jdk18on, bcprov-jdk18on to 1.79 ([#753](https://github.com/adzerk/apso/pull/753)).
- Update unirest-java-core to 4.4.5 ([#754](https://github.com/adzerk/apso/pull/754)).
- Update sbt, scripted-plugin to 1.10.5 ([#755](https://github.com/adzerk/apso/pull/755)).

[0.21.0]: https://github.com/adzerk/apso/compare/v0.20.0...v0.21.0

## [0.20.0] - 2024-10-16

This release is an exact copy of v0.19.7, but now published under the `com.kevel` namespace.
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Apso's latest release is built against Scala 2.12 and Scala 2.13.
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso" % "0.21.0"
```

The project is divided in modules, you can instead install only a specific module.

The TestKit is available under the `apso-testkit` project. You can include it only for the `test` configuration:

```scala
libraryDependencies += "com.kevel" %% "apso-testkit" % "0.20.0" % "test"
libraryDependencies += "com.kevel" %% "apso-testkit" % "0.21.0" % "test"
```

Please take into account that the library is still in an experimental stage and the interfaces might change for subsequent releases.
Expand Down Expand Up @@ -69,7 +69,7 @@ Please take into account that the library is still in an experimental stage and
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-core" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-core" % "0.21.0"
```

### Config
Expand Down Expand Up @@ -285,7 +285,7 @@ The same features are provided for Pekko under the `pekko-http` module.
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-akka-http" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-akka-http" % "0.21.0"
```

### ClientIPDirectives
Expand All @@ -307,7 +307,7 @@ Apso provides a group of classes to ease the interaction with the Amazon Web Ser
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-aws" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-aws" % "0.21.0"
```

### ConfigCredentialsProvider
Expand Down Expand Up @@ -354,7 +354,7 @@ The `apso-caching` module provides provides utilities for caching.
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-caching" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-caching" % "0.21.0"
```

Apso provides utilities to simplify the caching of method calls, with [ScalaCache](https://cb372.github.io/scalacache/) and using either `Guava` or `Caffeine` as underlying cache implementations.
Expand Down Expand Up @@ -408,7 +408,7 @@ y
The `apso-collections` module provides some helpful collections. To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-collections" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-collections" % "0.21.0"
```

### Trie
Expand Down Expand Up @@ -609,7 +609,7 @@ creation of the underlying Cyphers.
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-encryption" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-encryption" % "0.21.0"
```

The following shows the creation of `Encryptor` and `Decryptor` objects,
Expand All @@ -634,7 +634,7 @@ decryptor.get.decryptToString(encryptor.get.encryptToSafeString(secretData).get)
Apso provides utilities for various hashing functions. To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-hashing" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-hashing" % "0.21.0"
```

```scala
Expand All @@ -654,7 +654,7 @@ Apso provides methods to deal with IO-related features in the `io` module.
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-io" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-io" % "0.21.0"
```

### FileDescriptor
Expand Down Expand Up @@ -697,7 +697,7 @@ ResourceUtil.getResourceAsString("reference.conf")
Apso includes a bunch of utilities to work with JSON serialization and deserialization, specifically with the [circe](https://circe.github.io/circe/) library. To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-circe" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-circe" % "0.21.0"
```

### ExtraJsonProtocol
Expand Down Expand Up @@ -809,7 +809,7 @@ The `profiling` module of apso provides utilities to help with profiling the run
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-profiling" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-profiling" % "0.21.0"
```

### CpuSampler
Expand All @@ -827,7 +827,7 @@ The `apso-time` module provides utilities to work with `DateTime` and `LocalDate
To use it in an existing SBT project, add the following dependency to your `build.sbt`:

```scala
libraryDependencies += "com.kevel" %% "apso-time" % "0.20.0"
libraryDependencies += "com.kevel" %% "apso-time" % "0.21.0"
```

See the following sample usages:
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ lazy val docs = (project in file("apso-docs"))
mdocOut := (ThisBuild / baseDirectory).value,

mdocVariables := Map(
"VERSION" -> "0.20.0" // This version should be set to the currently released version.
"VERSION" -> "0.21.0" // This version should be set to the currently released version.
),

publish / skip := true
Expand Down