Skip to content

Commit

Permalink
Pekko becomes a TLP (#159)
Browse files Browse the repository at this point in the history
  • Loading branch information
pjfanning authored Mar 22, 2024
1 parent 7cbcb3f commit b383fc6
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 37 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
build:
name: Code is formatted
runs-on: ubuntu-latest
if: github.repository == 'apache/incubator-pekko-persistence-jdbc'
if: github.repository == 'apache/pekko-persistence-jdbc'
steps:
- name: Checkout current branch (full)
uses: actions/checkout@v4
Expand Down
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 @@ -9,7 +9,7 @@ on:
jobs:
publish-docs:
# runs on main repo only
if: github.repository == 'apache/incubator-pekko-persistence-jdbc'
if: github.repository == 'apache/pekko-persistence-jdbc'
name: Publish
runs-on: ubuntu-20.04
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-1.0-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:

jobs:
publish10:
if: github.repository == 'apache/incubator-pekko-persistence-jdbc'
if: github.repository == 'apache/pekko-persistence-jdbc'
name: Publish
runs-on: ubuntu-20.04
env:
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 @@ -11,7 +11,7 @@ on:
jobs:
publish:
# runs on main repo only
if: github.repository == 'apache/incubator-pekko-persistence-jdbc'
if: github.repository == 'apache/pekko-persistence-jdbc'
name: Publish
runs-on: ubuntu-20.04
env:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
This is the process for committing code into main.

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.
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/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/apache/incubator-pekko-persistence-jdbc/pulls).
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/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.
Expand Down Expand Up @@ -84,6 +84,6 @@ Example:

## How To Enforce These Guidelines?

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.
1. [Github Actions CI builds](https://github.com/apache/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.
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) Persistence JDBC
Apache Pekko Persistence JDBC
Copyright 2022-2024 The Apache Software Foundation

This product includes software developed at
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Please note that the H2 database is not recommended to be used as a production d

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.
- [GitHub discussions](https://github.com/apache/pekko-persistence-jdbc/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-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.
- [GitHub issues](https://github.com/apache/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

Expand Down
8 changes: 4 additions & 4 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import sbt.Keys._

ThisBuild / versionScheme := Some(VersionScheme.SemVerSpec)
sourceDistName := "apache-pekko-persistence-jdbc"
sourceDistIncubating := true
sourceDistIncubating := false

val mimaCompareVersion = "1.0.0"

Expand Down Expand Up @@ -55,7 +55,7 @@ lazy val migrator = project
.dependsOn(core % "compile->compile;test->test")

lazy val themeSettings = Seq(
pekkoParadoxGithub := Some("https://github.com/apache/incubator-pekko-persistence-jdbc"))
pekkoParadoxGithub := Some("https://github.com/apache/pekko-persistence-jdbc"))

lazy val docs = project
.enablePlugins(ProjectAutoPlugin, PekkoParadoxPlugin, ParadoxSitePlugin, PreprocessPlugin)
Expand All @@ -71,11 +71,11 @@ lazy val docs = project
Paradox / siteSubdirName := s"docs/pekko-persistence-jdbc/${if (isSnapshot.value) "snapshot" else version.value}",
Compile / paradoxProperties ++= Map(
"project.url" -> "https://pekko.apache.org/docs/pekko-persistence-jdbc/current/",
"github.base_url" -> "https://github.com/apache/incubator-pekko-persistence-jdbc/",
"github.base_url" -> "https://github.com/apache/pekko-persistence-jdbc/",
"canonical.base_url" -> "https://pekko.apache.org/docs/pekko-persistence-jdbc/current",
"pekko.version" -> "current",
"slick.version" -> Dependencies.SlickVersion,
"extref.github.base_url" -> s"https://github.com/apache/incubator-pekko-persistence-jdbc/blob/${if (isSnapshot.value) "main"
"extref.github.base_url" -> s"https://github.com/apache/pekko-persistence-jdbc/blob/${if (isSnapshot.value) "main"
else "v" + version.value}/%s",
// Slick
"extref.slick.base_url" -> s"https://scala-slick.org/doc/${Dependencies.SlickVersion}/%s",
Expand Down
13 changes: 5 additions & 8 deletions project/ProjectAutoPlugin.scala
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import sbt.Keys._
import sbt._
import sbt.plugins.JvmPlugin
import org.mdedetrich.apache.sonatype.ApacheSonatypePlugin
import ApacheSonatypePlugin.autoImport.apacheSonatypeDisclaimerFile
import sbtdynver.DynVerPlugin
import sbtdynver.DynVerPlugin.autoImport.dynverSonatypeSnapshots

Expand All @@ -24,13 +23,13 @@ object ProjectAutoPlugin extends AutoPlugin {
Seq(
homepage := Some(url("https://pekko.apache.org/docs/pekko-persistence-jdbc/current/")),
scmInfo := Some(
ScmInfo(url("https://github.com/apache/incubator-pekko-persistence-jdbc"),
"[email protected]:apache/incubator-pekko-persistence-jdbc.git")),
ScmInfo(url("https://github.com/apache/pekko-persistence-jdbc"),
"[email protected]:apache/pekko-persistence-jdbc.git")),
developers += Developer(
"contributors",
"Contributors",
"[email protected]",
url("https://github.com/apache/incubator-pekko-persistence-jdbc/graphs/contributors")),
url("https://github.com/apache/pekko-persistence-jdbc/graphs/contributors")),
description := "A plugin for storing events in an event journal pekko-persistence-jdbc",
startYear := Some(2022))

Expand Down Expand Up @@ -79,14 +78,12 @@ object ProjectAutoPlugin extends AutoPlugin {
List("-skip-packages", "pekko.pattern")
} ++ List("-doc-source-url", {
val branch = if (isSnapshot.value) "main" else s"v${version.value}"
s"https://github.com/apache/incubator-pekko-persistence-jdbc/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
s"https://github.com/apache/pekko-persistence-jdbc/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
},
"-doc-canonical-base-url",
"https://pekko.apache.org/api/pekko-persistence-jdbc/current/"),
// show full stack traces and test case durations
Test / testOptions += Tests.Argument("-oDF"),
resolvers += Resolver.jcenterRepo,
apacheSonatypeDisclaimerFile := Some((LocalRootProject / baseDirectory).value / "DISCLAIMER"))
Test / testOptions += Tests.Argument("-oDF"))

override lazy val buildSettings = Seq(
dynverSonatypeSnapshots := true)
Expand Down
8 changes: 4 additions & 4 deletions project/project-info.conf
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ project-info {
new-tab: false
}
issues: {
url: "https://github.com/apache/incubator-pekko-persistence-jdbc/issues"
url: "https://github.com/apache/pekko-persistence-jdbc/issues"
text: "GitHub issues"
}
release-notes: {
url: "https://github.com/apache/incubator-pekko-persistence-jdbc/releases"
url: "https://github.com/apache/pekko-persistence-jdbc/releases"
text: "GitHub releases"
}
forums: [
Expand All @@ -26,8 +26,8 @@ project-info {
url: "https://lists.apache.org/[email protected]"
}
{
text: "apache/incubator-pekko-persistence-jdbc discussion"
url: "https://github.com/apache/incubator-pekko-persistence-jdbc/discussions"
text: "apache/pekko-persistence-jdbc discussion"
url: "https://github.com/apache/pekko-persistence-jdbc/discussions"
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion scripts/link-validator.conf
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ site-link-validator {

ignore-prefixes = [
# GitHub will block with "429 Too Many Requests"
"https://github.com/apache/incubator-pekko-persistence-jdbc/"
"https://github.com/apache/pekko-persistence-jdbc/"
# MVN repository forbids access after a few requests
"https://mvnrepository.com/artifact/"
]
Expand Down

0 comments on commit b383fc6

Please sign in to comment.