You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2023/01/17 21:42:28 UTC
[incubator-pekko-persistence-dynamodb] branch main updated: update docs to use Pekko name (#10)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-persistence-dynamodb.git
The following commit(s) were added to refs/heads/main by this push:
new 97cfec3 update docs to use Pekko name (#10)
97cfec3 is described below
commit 97cfec37d01364246ebb775580bafc96f04d5089
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Tue Jan 17 22:42:22 2023 +0100
update docs to use Pekko name (#10)
---
CHANGELOG.md | 44 --------------------------------------------
CONTRIBUTING.md | 17 ++++++-----------
README.md | 32 +++++++++-----------------------
3 files changed, 15 insertions(+), 78 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index db605ab..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,44 +0,0 @@
-Changelog
-=========
-
-v 1.3.0
---------------------
-
-* Implementation of Akka Persistence Query. Thanks [Joost de Vries](https://github.com/joost-de-vries)!
- See (Configuration)[#read-journal-akka-persistence-query) for required setup.
-
-v 1.1.2 (v 1.2.0)
-----------------------------
-
-This was supposed to be released as `v1.2.0` but was released as `v1.1.2` to maven. Sorry about that!
-
-* Use DynamoDB Query during journal replay - https://github.com/akka/akka-persistence-dynamodb/issues/106
-* Correct issue [#98](https://github.com/akka/akka-persistence-dynamodb/issues/98)
- Please see [fixes in `reference.conf`](blob/master/src/main/resources/reference.conf) for a workaround for systems impacted by this issues.
-* Depends on Akka 2.5.
-* Adds Support for the Async Serializers - which enables the use of the plugin with Lightbend extensions [GDPR Addons](https://developer.lightbend.com/docs/akka-commercial-addons/current/gdpr/index.html)
-
-Schema changes are required in order to support async serializers as we need to know what data deserializer to use for the data payload.
-The data payload is stored in a dedicated `event` field. Going towards similar schema as [akka-persistence-cassandra](https://github.com/akka/akka-persistence-cassandra)
-
-*Journal Plugin*
-~~~
-val Event = "event" -> PeristentRepr.payload
-val SerializerId = "ev_ser_id" -> Serializer id used for serializing event above
-val SerializerManifest = "ev_ser_manifest" -> Serializer manifest of the event above
-val Manifest = "manifest" -> String manifest used for whole PeristentRepr
-
-~~~
-
-*Snapshot Plugin*
-~~~
-val SerializerId = "ser_id" -> Serializer used for serializing the snapshot payload
-val SerializerManifest = "ser_manifest" -> String manifest of the snapshot payload
-val PayloadData = "pay_data" -> the actual serialized data of the snapshot, need to distinguish between the old a new format
-~~~
-The existence of the old `val Payload = "pay"` field triggers old serialization. The new serialization doesn't Serialize theq
-Snapshot wrapper class.
-
-
-Both Journal and Snapshot checks the existence of new data fields first and switches the behaviour in order
-to make the change backwards compatible.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5ca39b8..2d9698b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,30 +1,25 @@
-# Contributing to the Akka DynamoDB Persistence Plugin
+# Contributing to the Apache Pekko DynamoDB Persistence Plugin
## Infrastructure
-* [Typesafe Contributor License Agreement](http://www.typesafe.com/contribute/cla)
-* [Issue Tracker](https://github.com/akka/akka-persistence-dynamodb/issues)
+* [Apache Contributor License Agreement](https://www.apache.org/licenses/contributor-agreements.html)
+* [Issue Tracker](https://github.com/apache/incubator-pekko-persistence-dynamodb/issues)
* [Github Actions](https://github.com/apache/incubator-pekko-persistence-dynamodb/actions)
-# Typesafe Project & Developer Guidelines
+# Project & Developer Guidelines
These guidelines are meant to be a living document that should be changed and adapted as needed. We encourage changes that makes it easier to achieve our goals in an efficient way.
-These guidelines mainly apply to Typesafe’s “mature” projects - not necessarily to projects of the type ‘collection of scripts’ etc.
-
## General Workflow
This is the process for committing code into master. There are of course exceptions to these rules, for example minor changes to comments and documentation, fixing a broken build etc.
-1. Make sure you have signed the Typesafe CLA, if not, [sign it online](http://www.typesafe.com/contribute/cla).
+1. For non-trivial changes, you will be asked to submit a [CLA](https://www.apache.org/licenses/contributor-agreements.html) - if you do not have one on file.
2. Before starting to work on a feature or a fix, make sure that:
1. There is a ticket for your work in the project's issue tracker. If not, create it first.
2. The ticket has been scheduled for the current milestone.
3. The ticket have been discussed and prioritized by the team.
-3. You should always perform your work in a Git feature branch. The branch should be given a descriptive name that explains its intent. Some teams also like adding the ticket number and/or the [GitHub](http://github.com) user ID to the branch name, these details is up to each of the individual teams.
-
- Akka prefers the committer name as part of the branch name, the ticket number is optional.
-
+3. You should always perform your work in a Git feature branch.
4. When the feature or fix is completed you should open a [Pull Request](https://help.github.com/articles/using-pull-requests) on GitHub.
5. The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Note that the maintainers can consist of outside contributors, both within and outside Typesafe. Outside contributors (for example from EPFL or independent committers) are encouraged to participate in the review process, it is not a closed process.
6. After the review you should fix the issues as needed (pushing a new commit for new review etc.), iterating until the reviewers give their thumbs up.
diff --git a/README.md b/README.md
index 3762b3b..f9419ec 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,17 @@
-DynamoDBJournal for Akka Persistence
-====================================
+DynamoDBJournal for Apache Pekko Persistence
+============================================
-A replicated [Akka Persistence](http://doc.akka.io/docs/akka/2.4.0/scala/persistence.html) journal backed by
+A replicated Pekko Persistence journal backed by
[Amazon DynamoDB](http://aws.amazon.com/dynamodb/).
- This plugin implements both a journal as well as a snapshot store,
-- This includes a Akka Persistence Query plugin. However, this requires an additional GSI for efficient usage.
+- This includes a Pekko Persistence Query plugin. However, this requires an additional GSI for efficient usage.
Supported versions:
- Scala: `2.12.x`, `2.13.x`
-- Akka: `2.5.x+` and `2.6.x+`
+- Pekko: `1.0.x+`
- Java: `1.8+`
-[](https://gitter.im/akka/akka-persistence-dynamodb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/apache/incubator-pekko-persistence-dynamodb/actions)
Installation
@@ -22,16 +21,16 @@ This plugin is published to the Maven Central repository with the following name
~~~
<dependency>
- <groupId>com.typesafe.akka</groupId>
- <artifactId>akka-persistence-dynamodb_2.13</artifactId>
- <version>1.3.0</version>
+ <groupId>org.apache.pekko</groupId>
+ <artifactId>pekko-persistence-dynamodb_2.13</artifactId>
+ <version>1.0.0</version>
</dependency>
~~~
or for sbt users:
```sbt
-libraryDependencies += "com.typesafe.akka" %% "akka-persistence-dynamodb" % "1.3.0"
+libraryDependencies += "org.apache.pekko" %% "pekko-persistence-dynamodb" % "1.0.0"
```
Configuration
@@ -204,14 +203,6 @@ This is somewhat more difficult to code, but offers higher throughput possibilit
When writing an item we typically do not touch the high sequence number storage, only when writing an item with sort key `0` is this done. This implies that reading the highest sequence number will need to first query the sequence shards for the highest multiple of 100 and then send a `Query` for the corresponding P entry’s hash key to find the highest stored sort key number.
-Using with Akka 2.5.x
----------------------
-
-Please make sure to depend on all Akka artifacts (those with the artifact name begining with
-`akka-*`) are depended on in the same version - as mixing versions is *not* legal. For example, if
-you depend on Akka Persistence in `2.5.3`, make sure that Akka Streams and Actors are also depended
-on in the same version. Please always use the latest patch version available (!).
-
Credits
-------
@@ -222,8 +213,3 @@ Credits
- Ryan Means
- Jean-Luc Deprez
- Michal Janousek
-
-Support
--------
-
-This project is *community maintained*. The Lightbend subscription does not cover support for this project.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org