Skip to content
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Please note that the H2 database is not recommended to be used as a production d

## Documentation

* [current Akka Persistence JDBC documentation](https://doc.akka.io/docs/akka-persistence-jdbc/current/)
* [Akka Persistence JDBC 3.5.x documentation](https://doc.akka.io/docs/akka-persistence-jdbc/3.5/)
* [Snapshot documentation](https://doc.akka.io/docs/akka-persistence-jdbc/snapshot/)
* [current Akka Persistence JDBC documentation](https://doc.akka.io/libraries/akka-persistence-jdbc/current/)
* [Akka Persistence JDBC 3.5.x documentation](https://doc.akka.io/libraries/akka-persistence-jdbc/3.5/)
* [Snapshot documentation](https://doc.akka.io/libraries/akka-persistence-jdbc/snapshot/)

## Release notes

Expand Down Expand Up @@ -49,4 +49,4 @@ You can also ask for clarifications or guidance in GitHub issues directly, or in

Akka is licensed under the Business Source License 1.1, please see the [Akka License FAQ](https://www.lightbend.com/akka/license-faq).

Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.
Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.
12 changes: 6 additions & 6 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,21 @@ lazy val docs = project
Preprocess / siteSubdirName := s"api/akka-persistence-jdbc/${if (isSnapshot.value) "snapshot"
else version.value}",
Preprocess / sourceDirectory := (LocalRootProject / ScalaUnidoc / unidoc / target).value,
Paradox / siteSubdirName := s"docs/akka-persistence-jdbc/${if (isSnapshot.value) "snapshot" else version.value}",
Paradox / siteSubdirName := s"libraries/akka-persistence-jdbc/${if (isSnapshot.value) "snapshot" else version.value}",
Compile / paradoxProperties ++= Map(
"project.url" -> "https://doc.akka.io/docs/akka-persistence-jdbc/current/",
"project.url" -> "https://doc.akka.io/libraries/akka-persistence-jdbc/current/",
"github.base_url" -> "https://github.com/akka/akka-persistence-jdbc/",
"canonical.base_url" -> "https://doc.akka.io/docs/akka-persistence-jdbc/current",
"canonical.base_url" -> "https://doc.akka.io/libraries/akka-persistence-jdbc/current",
"akka.version" -> Dependencies.AkkaVersion,
"slick.version" -> Dependencies.SlickVersion,
"extref.github.base_url" -> s"https://github.com/akka/akka-persistence-jdbc/blob/${if (isSnapshot.value) "master"
else "v" + version.value}/%s",
// Slick
"extref.slick.base_url" -> s"https://scala-slick.org/doc/${Dependencies.SlickVersion}/%s",
// Akka
"extref.akka.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.AkkaBinaryVersion}/%s",
"scaladoc.akka.base_url" -> s"https://doc.akka.io/api/akka/${Dependencies.AkkaBinaryVersion}/",
"javadoc.akka.base_url" -> s"https://doc.akka.io/japi/akka/${Dependencies.AkkaBinaryVersion}/",
"extref.akka.base_url" -> s"https://doc.akka.io/libraries/akka-core/${Dependencies.AkkaBinaryVersion}/%s",
"scaladoc.akka.base_url" -> s"https://doc.akka.io/api/akka-core/${Dependencies.AkkaBinaryVersion}/",
"javadoc.akka.base_url" -> s"https://doc.akka.io/japi/akka-core/${Dependencies.AkkaBinaryVersion}/",
"javadoc.akka.link_style" -> "direct",
// Java
"javadoc.base_url" -> "https://docs.oracle.com/javase/8/docs/api/",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ object SchemaUtils {
* Drops the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to run any DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `jdbc-journal` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*/
@ApiMayChange
def dropIfExists(actorSystem: ClassicActorSystemProvider): CompletionStage[Done] =
Expand All @@ -40,14 +40,14 @@ object SchemaUtils {
* Drops the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to run any DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `configKey` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param configKey the database journal configuration key to use.
*/
Expand All @@ -59,14 +59,14 @@ object SchemaUtils {
* Creates the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to create run DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `jdbc-journal` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*/
@ApiMayChange
def createIfNotExists(actorSystem: ClassicActorSystemProvider): CompletionStage[Done] =
Expand All @@ -76,14 +76,14 @@ object SchemaUtils {
* Creates the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to create run DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `configKey` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param configKey the database journal configuration key to use.
*/
Expand All @@ -98,7 +98,7 @@ object SchemaUtils {
* For production, it's recommended to run any DDL statements before the system is started.
*
* It will use the database settings found under `jdbc-journal`, or `akka-persistence-jdbc.shared-databases` if configured so.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param script the DDL script. The passed script can contain more then one SQL statements separated by a ; (semi-colon).
*/
Expand All @@ -113,7 +113,7 @@ object SchemaUtils {
* For production, it's recommended to run any DDL statements before the system is started.
*
* It will use the database settings found under `configKey`, or `akka-persistence-jdbc.shared-databases` if configured so.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param script the DDL script. The passed `script` can contain more then one SQL statements.
* @param separator used to separate the different DDL statements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ object SchemaUtils {
* Drops the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to run any DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `jdbc-journal` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*/
@ApiMayChange
def dropIfExists()(implicit actorSystem: ClassicActorSystemProvider): Future[Done] =
Expand All @@ -38,14 +38,14 @@ object SchemaUtils {
* Drops the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to run any DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `configKey` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param configKey the database journal configuration key to use.
*/
Expand All @@ -57,14 +57,14 @@ object SchemaUtils {
* Creates the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to run any DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `jdbc-journal` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*/
@ApiMayChange
def createIfNotExists()(implicit actorSystem: ClassicActorSystemProvider): Future[Done] =
Expand All @@ -74,14 +74,14 @@ object SchemaUtils {
* Creates the schema for both the journal and the snapshot table using the default schema definition.
*
* For information about the different schemas and supported databases consult
* https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#database-schema
* https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#database-schema
*
* This utility method is intended to be used for testing only.
* For production, it's recommended to run any DDL statements before the system is started.
*
* This method will automatically detects the configured database using the settings from `configKey` config.
* If configured with `use-shared-db`, it will use the `akka-persistence-jdbc.shared-databases` definition instead.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param configKey the database journal configuration key to use.
*/
Expand All @@ -96,7 +96,7 @@ object SchemaUtils {
* For production, it's recommended to run any DDL statements before the system is started.
*
* It will use the database settings found under `jdbc-journal`, or `akka-persistence-jdbc.shared-databases` if configured so.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param script the DDL script. The passed script can contain more then one SQL statements separated by a ; (semi-colon).
*/
Expand All @@ -111,7 +111,7 @@ object SchemaUtils {
* For production, it's recommended to create the table with DDL statements before the system is started.
*
* It will use the database settings found under `configKey`, or `akka-persistence-jdbc.shared-databases` if configured so.
* See https://doc.akka.io/docs/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
* See https://doc.akka.io/libraries/akka-persistence-jdbc/current/index.html#sharing-the-database-connection-pool-between-the-journals for details.
*
* @param script the DDL script. The passed `script` can contain more then one SQL statements.
* @param separator used to separate the different DDL statements.
Expand Down
6 changes: 3 additions & 3 deletions docs/release-train-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Key links:
### Check availability

- [ ] Check [API](https://doc.akka.io/api/akka-persistence-jdbc/$VERSION$/) documentation
- [ ] Check [reference](https://doc.akka.io/docs/akka-persistence-jdbc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
- [ ] Check [reference](https://doc.akka.io/libraries/akka-persistence-jdbc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
- [ ] Check the release on https://repo.akka.io/maven/com/lightbend/akka/akka-persistence-jdbc_2.13/$VERSION$/akka-persistence-jdbc_2.13-$VERSION$.pom

### When everything is on https://repo.akka.io/maven
Expand All @@ -39,7 +39,7 @@ Key links:
```
cd ~/www
git status
git add docs/akka-persistence-jdbc/current docs/akka-persistence-jdbc/$VERSION$
git add libraries/akka-persistence-jdbc/current libraries/akka-persistence-jdbc/$VERSION$
git add api/akka-persistence-jdbc/current api/akka-persistence-jdbc/$VERSION$
git commit -m "Akka Persistence JDBC $VERSION$"
```
Expand All @@ -59,6 +59,6 @@ For minor or major releases:

### Afterwards

- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/docs/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies)
- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/libraries/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies)
- [ ] Update [Akka Guide samples](https://github.com/akka/akka-platform-guide)
- Close this issue
2 changes: 1 addition & 1 deletion docs/src/main/paradox/snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ Gradle

## Documentation

The [snapshot documentation](https://doc.akka.io/docs/akka-persistence-jdbc/snapshot) is updated with every snapshot build.
The [snapshot documentation](https://doc.akka.io/libraries/akka-persistence-jdbc/snapshot) is updated with every snapshot build.

2 changes: 1 addition & 1 deletion project/Dependencies.scala
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ object Dependencies {
val ScalaVersions = Seq(Scala213, Scala3)

val AkkaVersion = "2.10.0-M1"
val AkkaBinaryVersion = AkkaVersion.take(3)
val AkkaBinaryVersion = VersionNumber(AkkaVersion).numbers match { case Seq(major, minor, _*) => s"$major.$minor" }

val SlickVersion = "3.5.1"
val ScalaTestVersion = "3.2.19"
Expand Down
2 changes: 1 addition & 1 deletion project/ProjectAutoPlugin.scala
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ object ProjectAutoPlugin extends AutoPlugin {
organization := "com.lightbend.akka",
organizationName := "Lightbend Inc.",
organizationHomepage := Some(url("https://www.lightbend.com/")),
homepage := Some(url("https://doc.akka.io/docs/akka-persistence-jdbc/current/")),
homepage := Some(url("https://doc.akka.io/libraries/akka-persistence-jdbc/current/")),
scmInfo := Some(
ScmInfo(url("https://github.com/akka/akka-persistence-jdbc"), "[email protected]:akka/akka-persistence-jdbc.git")),
developers += Developer(
Expand Down
6 changes: 3 additions & 3 deletions scripts/link-validator.conf
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
site-link-validator {
root-dir = "./docs/target/site/"
# relative to `root-dir`
start-file = "docs/akka-persistence-jdbc/snapshot/index.html"
start-file = "libraries/akka-persistence-jdbc/snapshot/index.html"

# Resolves URLs with the given prefix as local files instead
link-mappings = [
{
prefix = "https://doc.akka.io/docs/akka-persistence-jdbc/snapshot/"
replace = "/docs/akka-persistence-jdbc/snapshot/"
prefix = "https://doc.akka.io/libraries/akka-persistence-jdbc/snapshot/"
replace = "/libraries/akka-persistence-jdbc/snapshot/"
}
{
prefix = "https://doc.akka.io/api/akka-persistence-jdbc/snapshot/"
Expand Down
Loading