Skip to content

Commit

Permalink
Pekko becomes a TLP (#146)
Browse files Browse the repository at this point in the history
* Pekko becomes a TLP

* Update ProjectSettings.scala
  • Loading branch information
pjfanning authored Mar 22, 2024
1 parent 291e3ec commit 8ca22ab
Show file tree
Hide file tree
Showing 18 changed files with 34 additions and 46 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish-1.0-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
publish-docs:
name: Publish documentation to nightlies.apache.org
runs-on: ubuntu-latest
if: github.repository == 'apache/incubator-pekko-connectors-kafka'
if: github.repository == 'apache/pekko-connectors-kafka'
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
publish-nightly:
name: Publish nightly
runs-on: ubuntu-20.04
if: github.repository == 'apache/incubator-pekko-connectors-kafka'
if: github.repository == 'apache/pekko-connectors-kafka'
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ You're always welcome to submit your PR straight away and start the discussion (

This is the process for committing code into main.

1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/incubator-pekko-connectors-kafka/issues) and [existing pull requests](https://github.com/apache/incubator-pekko-connectors-kafka/pulls) for existing work.
- If there is no ticket yet, feel free to [create one](https://github.com/apache/incubator-pekko-connectors-kafka/issues/new) to discuss the problem and the approach you want to take to solve it.
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/pekko-connectors-kafka/issues) and [existing pull requests](https://github.com/apache/pekko-connectors-kafka/pulls) for existing work.
- If there is no ticket yet, feel free to [create one](https://github.com/apache/pekko-connectors-kafka/issues/new) to discuss the problem and the approach you want to take to solve it.

1. Perform your work according to the [pull request requirements](#pull-request-requirements).

1. 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-connectors-kafka/pulls).
1. 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/pekko-connectors-kafka/pulls).

1. 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.

Expand Down Expand Up @@ -114,6 +114,6 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs

## How To Enforce These Guidelines?

1. [GitHub Actions](https://github.com/apache/incubator-pekko-connectors-kafka/actions) automatically merges the code, builds it, runs the tests and sets Pull Request status accordingly of results in GitHub.
1. [GitHub Actions](https://github.com/apache/pekko-connectors-kafka/actions) automatically merges the code, builds it, runs the tests and sets Pull Request status accordingly of results in GitHub.
1. [Scalafmt](http://scalameta.org/scalafmt/) enforces some of the code style rules.
1. [sbt-header plugin](https://github.com/sbt/sbt-header) manages consistent copyright headers in every source file.
10 changes: 0 additions & 10 deletions DISCLAIMER

This file was deleted.

2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Apache Pekko (Incubating) Connectors Kafka
Apache Pekko Connectors Kafka
Copyright 2022-2024 The Apache Software Foundation

This product includes software developed at
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Apache Pekko Kafka Connector [![scaladex-badge][]][scaladex] [![maven-central-badge][]][maven-central] [![gh-actions-badge][]][gh-actions]

[scaladex]: https://index.scala-lang.org/apache/incubator-pekko-connectors-kafka/
[scaladex-badge]: https://index.scala-lang.org/apache/incubator-pekko-connectors-kafka/latest.svg?target=_2.13
[scaladex]: https://index.scala-lang.org/apache/pekko-connectors-kafka/
[scaladex-badge]: https://index.scala-lang.org/apache/pekko-connectors-kafka/latest.svg?target=_2.13
[maven-central]: https://maven-badges.herokuapp.com/maven-central/org.apache.pekko/pekko-connectors-kafka_2.13
[maven-central-badge]: https://maven-badges.herokuapp.com/maven-central/org.apache.pekko/pekko-connectors-kafka_2.13/badge.svg
[gh-actions]: https://github.com/apache/incubator-pekko-connectors-kafka/actions
[gh-actions-badge]: https://github.com/apache/incubator-pekko-connectors-kafka/workflows/CI/badge.svg?branch=main
[gh-actions]: https://github.com/apache/pekko-connectors-kafka/actions
[gh-actions-badge]: https://github.com/apache/pekko-connectors-kafka/workflows/CI/badge.svg?branch=main


Systems don't come alone. In the modern world of microservices and cloud deployment, new components must interact with legacy systems, making integration an important key to success. Reactive Streams give us a technology-independent tool to let these heterogeneous systems communicate without overwhelming each other.
Expand All @@ -14,7 +14,7 @@ The Apache Pekko Connectors project is an open source initiative to implement st

This repository contains the sources for the **Apache Pekko Kafka Connector**. Which lets you connect [Apache Kafka](https://kafka.apache.org/) to Pekko Streams.

Pekko connectors to other technologies are listed in the [Pekko connectors repository](https://github.com/apache/incubator-pekko-connectors).
Pekko connectors to other technologies are listed in the [Pekko connectors repository](https://github.com/apache/pekko-connectors).

The Apache Pekko Kafka Connector is a fork of [Alpakka Kafka](https://github.com/akka/alpakka-kafka) 3.0.1, prior to the Akka project's adoption of the Business Source License.

Expand All @@ -32,7 +32,7 @@ See https://pekko.apache.org for the documentation including the API docs. The d

### Running the Build
- Open a command window and change directory to your preferred base directory
- Use git to clone the [repo](https://github.com/apache/incubator-pekko-connectors-kafka) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate)
- Use git to clone the [repo](https://github.com/apache/pekko-connectors-kafka) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate)
- Change directory to the directory where you installed the source (you should have a file called `build.sbt` in this directory)
- `sbt compile` compiles the main source for project default version of Scala (2.13)
- `sbt +compile` will compile for all supported versions of Scala
Expand Down Expand Up @@ -61,10 +61,10 @@ See https://pekko.apache.org for the documentation including the API docs. The d

You can join these forums and chats to discuss and ask Pekko and Pekko connector related questions:

- [GitHub discussions](https://github.com/apache/incubator-pekko-connectors-kafka/discussions): for questions and general discussion.
- [GitHub discussions](https://github.com/apache/pekko-connectors-kafka/discussions): for questions and general discussion.
- [Pekko dev mailing list](https://lists.apache.org/[email protected]): for Pekko development discussions.
- [Pekko users mailing list](https://lists.apache.org/[email protected]): for Pekko user discussions.
- [GitHub issues](https://github.com/apache/incubator-pekko-connectors-kafka/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.
- [GitHub issues](https://github.com/apache/pekko-connectors-kafka/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

Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import com.typesafe.tools.mima.core.{ Problem, ProblemFilters }
import ProjectSettings.commonSettings

sourceDistName := "apache-pekko-connectors-kafka"
sourceDistIncubating := true
sourceDistIncubating := false

ThisBuild / pekkoInlineEnabled := false
ThisBuild / reproducibleBuildsCheckResolver := Resolver.ApacheMavenStagingRepo
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/cluster-sharding.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There are two steps required to setup the cluster sharding module.

@@@ note

A complete example of using this module exists in an [`apache/incubator-pekko-samples`](https://github.com/apache/incubator-pekko-samples) project called [`pekko-sample-kafka-to-sharding-scala`](https://github.com/apache/incubator-pekko-samples/tree/main/pekko-sample-kafka-to-sharding-scala).
A complete example of using this module exists in an [`apache/pekko-samples`](https://github.com/apache/pekko-samples) project called [`pekko-sample-kafka-to-sharding-scala`](https://github.com/apache/pekko-samples/tree/main/pekko-sample-kafka-to-sharding-scala).
It's a self-contained example that can run on a developer's laptop.

@@@
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/paradox/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The table below shows Apache Pekko Connectors Kafka's direct dependencies and th

@@dependencies { projectId="core" }

* Apache Pekko Streams $pekko.version$ @extref[documentation](pekko:stream/index.html) and [sources](https://github.com/apache/incubator-pekko)
* Apache Pekko Streams $pekko.version$ @extref[documentation](pekko:stream/index.html) and [sources](https://github.com/apache/pekko)
* Apache Kafka client $kafka.version$ @extref[documentation](kafka:/documentation#index) and [sources](https://github.com/apache/kafka)


Expand All @@ -63,14 +63,14 @@ that are producing or consuming messages to/from Kafka.

## Examples

A few self-contained examples using Apache Pekko Connectors are available as [Apache Pekko Connectors Samples](https://github.com/apache/incubator-pekko-connectors-samples/).
A few self-contained examples using Apache Pekko Connectors are available as [Apache Pekko Connectors Samples](https://github.com/apache/pekko-connectors-samples/).

To read and see how others use Apache Pekko Connectors, see the [Apache Pekko Connectors documentation's Webinars, Presentations and Articles](https://pekko.apache.org/docs/pekko-connectors-kafka/current/other-docs/webinars-presentations-articles.html) listing.


## Contributing

Please feel free to contribute to Apache Pekko Connectors and the Apache Pekko Connectors Kafka connector by reporting issues you identify, or by suggesting changes to the code. Please refer to our [contributing instructions](https://github.com/apache/incubator-pekko-connectors-kafka/blob/main/CONTRIBUTING.md) to learn how it can be done.
Please feel free to contribute to Apache Pekko Connectors and the Apache Pekko Connectors Kafka connector by reporting issues you identify, or by suggesting changes to the code. Please refer to our [contributing instructions](https://github.com/apache/pekko-connectors-kafka/blob/main/CONTRIBUTING.md) to learn how it can be done.

We want Apache Pekko and Apache Pekko Connectors to strive in a welcoming and open atmosphere and expect all contributors to respect our [code of conduct](https://www.apache.org/foundation/policies/conduct.html).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ project.description: Consider these areas when using Apache Pekko Connectors Kaf

@@@ note

This is just a start, please add your experiences to this list by [opening a Pull Request](https://github.com/apache/incubator-pekko-connectors-kafka/pulls).
This is just a start, please add your experiences to this list by [opening a Pull Request](https://github.com/apache/pekko-connectors-kafka/pulls).

@@@

Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/paradox/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ properly acknowledged, please get in touch.
### Bug Fixes
We haven't had to fix many significant bugs that were in Alpakka Kafka 3.0.1.

* Properly mask all sensitive fields in Consumer and Producer settings [PR100](https://github.com/apache/incubator-pekko-connectors-kafka/pull/100) (Alpakka Kafka [CVE-2023-29471](https://akka.io/security/alpakka-kafka-cve-2023-29471.html))
* Properly mask all sensitive fields in Consumer and Producer settings [PR100](https://github.com/apache/pekko-connectors-kafka/pull/100) (Alpakka Kafka [CVE-2023-29471](https://akka.io/security/alpakka-kafka-cve-2023-29471.html))

### Additions

* Scala 3 support ([PR58](https://github.com/apache/incubator-pekko-connectors-kafka/pull/58))
* Scala 3 support ([PR58](https://github.com/apache/pekko-connectors-kafka/pull/58))
* minimum version of Scala 3.3.0 required

### Dependency Upgrades
Expand Down
2 changes: 1 addition & 1 deletion legal/PekkoKafkaNotice.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Apache Pekko (Incubating) Connectors Kafka
Apache Pekko Connectors Kafka
Copyright 2022-2024 The Apache Software Foundation

This product includes software developed at
Expand Down
3 changes: 1 addition & 2 deletions project/AddMetaInfLicenseFiles.scala
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ object AddMetaInfLicenseFiles extends AutoPlugin {

override lazy val projectSettings = Seq(
apacheSonatypeLicenseFile := baseDir.value / "legal" / "StandardLicense.txt",
apacheSonatypeNoticeFile := baseDir.value / "legal" / "PekkoKafkaNotice.txt",
apacheSonatypeDisclaimerFile := Some((LocalRootProject / baseDirectory).value / "DISCLAIMER"))
apacheSonatypeNoticeFile := baseDir.value / "legal" / "PekkoKafkaNotice.txt")

/**
* Settings specific for Pekko Kafka cluster-sharding subproject which require a different license file.
Expand Down
2 changes: 1 addition & 1 deletion project/ParadoxSettings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ object ParadoxSettings {
val themeSettings = Seq(
// allow access to snapshots for pekko-sbt-paradox
resolvers += "Apache Nexus Snapshots".at("https://repository.apache.org/content/repositories/snapshots/"),
pekkoParadoxGithub := Some("https://github.com/apache/incubator-pekko-connectors-kafka"))
pekkoParadoxGithub := Some("https://github.com/apache/pekko-connectors-kafka"))

val propertiesSettings = Seq(
apidocRootPackage := "org.apache.pekko",
Expand Down
11 changes: 5 additions & 6 deletions project/ProjectSettings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ object ProjectSettings extends AutoPlugin {

lazy val commonSettings: Seq[Def.Setting[_]] = Def.settings(
homepage := Some(url("https://pekko.apache.org/docs/pekko-connectors-kafka/current/")),
scmInfo := Some(ScmInfo(url("https://github.com/apache/incubator-pekko-connectors-kafka"),
"[email protected]:apache/incubator-pekko-connectors-kafka.git")),
scmInfo := Some(ScmInfo(url("https://github.com/apache/pekko-connectors-kafka"),
"[email protected]:apache/pekko-connectors-kafka.git")),
developers += Developer(
"pekko-connectors-kafka",
"Apache Pekko Connectors Kafka Contributors",
"[email protected]",
url("https://github.com/apache/incubator-pekko-connectors-kafka/graphs/contributors")),
url("https://github.com/apache/pekko-connectors-kafka/graphs/contributors")),
startYear := Some(2022),
description := "Apache Pekko Kafka Connector is a Reactive Enterprise Integration library for Java and Scala, based on Reactive Streams and Apache Pekko.",
crossScalaVersions := Seq(Scala212, Scala213, Scala3),
Expand Down Expand Up @@ -105,7 +105,7 @@ object ProjectSettings extends AutoPlugin {
else Seq.empty) ++ Seq(
"-doc-source-url", {
val branch = if (isSnapshot.value) "main" else s"v${version.value}"
s"https://github.com/apache/incubator-pekko-connectors-kafka/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
s"https://github.com/apache/pekko-connectors-kafka/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
},
"-doc-canonical-base-url",
"https://pekko.apache.org/api/pekko-connectors-kafka/current/"),
Expand All @@ -121,8 +121,7 @@ object ProjectSettings extends AutoPlugin {
scalafmtOnCompile := false,
javafmtOnCompile := false,
ThisBuild / mimaReportSignatureProblems := true,
projectInfoVersion := (if (isSnapshot.value) "snapshot" else version.value),
apacheSonatypeDisclaimerFile := Some((LocalRootProject / baseDirectory).value / "DISCLAIMER"))
projectInfoVersion := (if (isSnapshot.value) "snapshot" else version.value))

override lazy val buildSettings = Seq(
dynverSonatypeSnapshots := true)
Expand Down
2 changes: 1 addition & 1 deletion project/VersionGenerator.scala
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import sbt.Keys._
/**
* Generate version.conf and org/apache/pekko/kafka/Version.scala files based on the version setting.
*
* This was adapted from https://github.com/apache/incubator-pekko/blob/main/project/VersionGenerator.scala
* This was adapted from https://github.com/apache/pekko/blob/main/project/VersionGenerator.scala
*/
object VersionGenerator {

Expand Down
2 changes: 1 addition & 1 deletion project/Versions.scala
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ object Versions {
val kafkaVersion = "3.0.2"
val KafkaVersionForDocs = "30"
// This should align with the ScalaTest version used in the Apache Pekko 1.0.x testkit
// https://github.com/apache/incubator-pekko/blob/main/project/Dependencies.scala
// https://github.com/apache/pekko/blob/main/project/Dependencies.scala
val scalaTestVersion = "3.2.14"
val scalaPBVersion = "0.11.13"
val testcontainersVersion = "1.16.3"
Expand Down
2 changes: 1 addition & 1 deletion project/project-info.conf
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ project-info {
new-tab: false
}
issues: {
url: "https://github.com/apache/incubator-pekko-connectors-kafka/issues"
url: "https://github.com/apache/pekko-connectors-kafka/issues"
text: "Github issues"
}
release-notes: {
Expand Down

0 comments on commit 8ca22ab

Please sign in to comment.