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:22:51 UTC
[incubator-pekko-persistence-jdbc] branch main updated: add license/notice to jars (#5)
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-jdbc.git
The following commit(s) were added to refs/heads/main by this push:
new 9740116 add license/notice to jars (#5)
9740116 is described below
commit 97401164ae5a479b95054e3746ce0f51007f39e6
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Tue Jan 17 22:22:46 2023 +0100
add license/notice to jars (#5)
---
CONTRIBUTING.md | 14 ++++++-------
LICENSE | 2 +-
NOTICE | 12 ++++++++++++
README.md | 36 +++++++++++-----------------------
build.sbt | 4 ++++
project/MetaInfLicenseNoticeCopy.scala | 30 ++++++++++++++++++++++++++++
project/build.properties | 2 +-
7 files changed, 65 insertions(+), 35 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9243663..0743210 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,19 +1,17 @@
-# Contributing to Akka Persistence JDBC
+# Contributing to Apache Pekko Persistence JDBC
## General Workflow
This is the process for committing code into master.
-1. Make sure you have signed the Lightbend CLA, if not, [sign it online](https://www.lightbend.com/contribute/cla).
-2. Before starting to work on a feature or a fix, make sure that there is a ticket for your work in the [issue tracker](https://github.com/akka/akka-persistence-jdbc/issues). If not, create it first.
+1. For non-trivial changes, you will be asked to sign the [CLA](https://www.apache.org/licenses/contributor-agreements.html) if you have not done so before.
+2. Before starting to work on a feature or a fix, make sure that there is a ticket for your work in the [issue tracker](https://github.com/apache/incubator-pekko-persistence-jdbc/issues). If not, create it first.
3. Perform your work according to the [pull request requirements](#pull-request-requirements).
-4. When the feature or fix is completed you should open a [Pull Request](https://help.github.com/articles/using-pull-requests) on [GitHub](https://github.com/akka/akka-persistence-jdbc/pulls).
-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 Lightbend. Outside contributors are encouraged to participate in the review process, it is not a closed process.
+4. When the feature or fix is completed you should open a [Pull Request](https://help.github.com/articles/using-pull-requests) on [GitHub](https://github.com/apache/incubator-pekko-persistence-jdbc/pulls).
+5. The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Outside contributors are encouraged to participate in the review process, it is not a closed process.
6. After the review you should fix the issues (review comments, CI failures) by pushing a new commit for new review, iterating until the reviewers give their thumbs up and CI tests pass.
7. If the branch merge conflicts with its target, rebase your branch onto the target branch.
-In case of questions about the contribution process or for discussion of specific issues please visit the [akka/dev gitter chat](https://gitter.im/akka/dev).
-
## Pull Request Requirements
For a Pull Request to be considered at all it has to meet these requirements:
@@ -78,6 +76,6 @@ Example:
## How To Enforce These Guidelines?
-1. [Travis CI](https://travis-ci.org/akka/akka-persistence-jdbc) automatically merges the code, builds it, runs the tests and sets Pull Request status accordingly of results in GitHub.
+1. [Github Actions CI builds](https://github.com/apache/incubator-pekko-persistence-jdbc/actions) builds artifacts, runs the tests and sets Pull Request status accordingly of results in GitHub.
2. [Scalafmt](https://scalameta.org/scalafmt/) enforces some of the code style rules.
3. [sbt-header plugin](https://github.com/sbt/sbt-header) manages consistent copyright headers in every source file.
diff --git a/LICENSE b/LICENSE
index 7a4a3ea..d645695 100644
--- a/LICENSE
+++ b/LICENSE
@@ -199,4 +199,4 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
- limitations under the License.
\ No newline at end of file
+ limitations under the License.
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..2eb96cb
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,12 @@
+Apache Pekko Persistence JDBC
+Copyright 2022, 2023 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).
+
+This product contains significant parts that were originally based on software from Lightbend (Akka <https://akka.io/>).
+Copyright (C) 2014 - 2019 Dennis Vriend <https://github.com/dnvriend>
+Copyright (C) 2019 - 2022 Lightbend Inc. <https://www.lightbend.com>
+
+Apache Pekko Persistence JDBC is derived from Akka Persistence JDBC 5.1.x, the last version that was distributed under the
+Apache License, Version 2.0 License.
diff --git a/README.md b/README.md
index 1f2a116..fc63be4 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
-# Akka Persistence JDBC
-## Use JDBC-compatible databases with Akka Persistence
+# Apache Pekko Persistence JDBC
+## Use JDBC-compatible databases with Pekko Persistence
-[](https://travis-ci.com/github/akka/akka-persistence-jdbc)
[](https://www.apache.org/licenses/LICENSE-2.0.txt)
-akka-persistence-jdbc writes journal and snapshot entries to a configured JDBC store. It implements the full akka-persistence-query API and is therefore very useful for implementing DDD-style
-application models using Akka for creating reactive applications.
+pekko-persistence-jdbc writes journal and snapshot entries to a configured JDBC store. It implements the full pekko-persistence-query API and is therefore very useful for implementing DDD-style
+application models using Pekko for creating reactive applications.
Please note that the H2 database is not recommended to be used as a production database, and support for H2 is primarily for testing purposes.
@@ -17,35 +16,22 @@ Please note that the H2 database is not recommended to be used as a production d
## Release notes
-The release notes can be found [here](https://github.com/akka/akka-persistence-jdbc/releases).
-
-For the change log prior to v3.2.0, visit [Version History Page (wiki)](https://github.com/akka/akka-persistence-jdbc/wiki/Version-History).
+The release notes can be found [here](https://github.com/apache/incubator-pekko-persistence-jdbc/releases).
## Community
-You can join these groups and chats to discuss and ask Akka related questions:
-
-- Forums: [discuss.akka.io](https://discuss.lightbend.com/c/akka/)
-- Chat room about **Akka**: [](https://gitter.im/akka/akka)
-- Issue tracker: [](https://github.com/akka/akka-persistence-jdbc/issues)
-
-In addition to that, you may enjoy following:
-
-- The [Akka Team Blog](https://akka.io/blog/)
-- [@akkateam](https://twitter.com/akkateam) on Twitter
-- Questions tagged [#akka on StackOverflow](https://stackoverflow.com/questions/tagged/akka)
-
-The Akka Peristence JDBC was originally created by @dnvriend.
+There are several ways to interact with the Pekko community:
+- [GitHub discussions](https://github.com/apache/incubator-pekko-persistence-jdbc/discussions): for questions and general discussion.
+- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.
+- [GitHub issues](https://github.com/apache/incubator-pekko-persistence-jdbc/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.
## Contributing
-Contributions are *very* welcome! The Akka team appreciates community contributions by both those new to Akka and those more experienced.
+Contributions are *very* welcome! The Apache Pekko team appreciates community contributions by both those new to Pekko and those more experienced.
If you find an issue that you'd like to see fixed, the quickest way to make that happen is to implement the fix and submit a pull request.
Refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details about the workflow, and general hints on how to prepare your pull request.
-You can also ask for clarifications or guidance in GitHub issues directly, or in the [akka/dev](https://gitter.im/akka/dev) chat if a more real time communication would be of benefit.
-
-[Lightbend](https://www.lightbend.com/) is backing Akka, Akka Persistence and other Reactive technologies.
+You can also ask for clarifications or guidance in GitHub issues directly.
diff --git a/build.sbt b/build.sbt
index e6635bc..c471886 100644
--- a/build.sbt
+++ b/build.sbt
@@ -9,6 +9,7 @@ lazy val `akka-persistence-jdbc` = project
.disablePlugins(MimaPlugin, SitePlugin)
.aggregate(core, docs, migrator)
.settings(publish / skip := true)
+ .settings(MetaInfLicenseNoticeCopy.settings)
lazy val core = project
.in(file("core"))
@@ -16,6 +17,7 @@ lazy val core = project
.disablePlugins(SitePlugin)
.configs(IntegrationTest.extend(Test))
.settings(Defaults.itSettings)
+ .settings(MetaInfLicenseNoticeCopy.settings)
.settings(
name := "akka-persistence-jdbc",
libraryDependencies ++= Dependencies.Libraries,
@@ -28,6 +30,7 @@ lazy val migrator = project
.disablePlugins(SitePlugin, MimaPlugin)
.configs(IntegrationTest.extend(Test))
.settings(Defaults.itSettings)
+ .settings(MetaInfLicenseNoticeCopy.settings)
.settings(
name := "akka-persistence-jdbc-migrator",
libraryDependencies ++= Dependencies.Migration ++ Dependencies.Libraries,
@@ -38,6 +41,7 @@ lazy val migrator = project
lazy val docs = project
.enablePlugins(ProjectAutoPlugin, AkkaParadoxPlugin, ParadoxSitePlugin, PreprocessPlugin, PublishRsyncPlugin)
.disablePlugins(MimaPlugin)
+ .settings(MetaInfLicenseNoticeCopy.settings)
.settings(
name := "Akka Persistence JDBC",
publish / skip := true,
diff --git a/project/MetaInfLicenseNoticeCopy.scala b/project/MetaInfLicenseNoticeCopy.scala
new file mode 100644
index 0000000..1965dc5
--- /dev/null
+++ b/project/MetaInfLicenseNoticeCopy.scala
@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+import sbt.Keys._
+import sbt._
+
+/**
+ * Copies LICENSE and NOTICE files into jar META-INF dir
+ */
+object MetaInfLicenseNoticeCopy {
+
+ val settings: Seq[Setting[_]] = inConfig(Compile)(
+ Seq(
+ resourceGenerators += copyFileToMetaInf(resourceManaged, "LICENSE"),
+ resourceGenerators += copyFileToMetaInf(resourceManaged, "NOTICE")))
+
+ def copyFileToMetaInf(dir: SettingKey[File], fileName: String) = Def.task[Seq[File]] {
+ val fromFile = (LocalRootProject / baseDirectory).value / fileName
+ val toFile = resourceManaged.value / "META-INF" / fileName
+ IO.copyFile(fromFile, toFile)
+ Seq(toFile)
+ }
+
+}
diff --git a/project/build.properties b/project/build.properties
index c9fa4e1..f1fdbf4 100644
--- a/project/build.properties
+++ b/project/build.properties
@@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-sbt.version=1.8.0
+sbt.version=1.8.2
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org