Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pekko becomes a TLP #247

Merged
merged 1 commit into from
Mar 22, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/nightly-snapshot-dependency-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
sbt:
name: sbt test with pekko/pekko-main 1.1 snapshots
runs-on: ubuntu-latest
if: github.repository == 'apache/incubator-pekko-grpc'
if: github.repository == 'apache/pekko-grpc'
steps:
- name: Checkout
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 @@ -7,7 +7,7 @@ jobs:
publish-docs:
name: sbt publish
runs-on: ubuntu-latest
if: github.repository == 'apache/incubator-pekko-grpc'
if: github.repository == 'apache/pekko-grpc'
steps:
- name: Checkout
uses: actions/checkout@v4
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 @@ -9,7 +9,7 @@ jobs:
sbt:
name: sbt publish
runs-on: ubuntu-latest
if: github.repository == 'apache/incubator-pekko-grpc'
if: github.repository == 'apache/pekko-grpc'
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 @@ -9,7 +9,7 @@ jobs:
sbt:
name: sbt publish
runs-on: ubuntu-latest
if: github.repository == 'apache/incubator-pekko-grpc'
if: github.repository == 'apache/pekko-grpc'
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ The [Release Notes](https://pekko.apache.org/docs/pekko-grpc/current/release-not

GitHub has a feature allowing you to compare 2 Git tags and see the PRs and overall code diff. You can take the example URL below and tweak it with the version tags that you want to compare.

https://github.com/apache/incubator-pekko-grpc/compare/v1.0.0...v1.0.1
https://github.com/apache/pekko-grpc/compare/v1.0.0...v1.0.1
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ You're always welcome to submit your PR straight away and start the discussion (

If you have questions about the contribution process or discuss specific issues, please interact with the community using the following resources.

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

# Navigating around the project & codebase

Expand All @@ -25,13 +25,13 @@ Depending on which version (or sometimes module) you want to work on, you should
In general *all issues are open for anyone working on them*, however if you're new to the project and looking for an issue
that will be accepted and likely is a nice one to get started you should check out the following tags:

- [help wanted](https://github.com/apache/incubator-pekko-grpc/labels/help%20wanted) - which identifies issues that the core team will likely not have time to work on, or the issue is a nice entry level ticket. If you're not sure how to solve a ticket but would like to work on it feel free to ask in the issue about clarification or tips.
- [nice-to-have (low-priority)](https://github.com/apache/incubator-pekko-grpc/labels/nice-to-have%20%28low-prio%29) - are tasks which make sense, however are not very high priority (in face of other very high priority issues). If you see something interesting in this list, a contribution would be really wonderful!
- [help wanted](https://github.com/apache/pekko-grpc/labels/help%20wanted) - which identifies issues that the core team will likely not have time to work on, or the issue is a nice entry level ticket. If you're not sure how to solve a ticket but would like to work on it feel free to ask in the issue about clarification or tips.
- [nice-to-have (low-priority)](https://github.com/apache/pekko-grpc/labels/nice-to-have%20%28low-prio%29) - are tasks which make sense, however are not very high priority (in face of other very high priority issues). If you see something interesting in this list, a contribution would be really wonderful!

Another group of special tags indicate specific states a ticket is in:

- [bug](https://github.com/apache/incubator-pekko-grpc/labels/bug) - bugs take priority in being fixed above features. The core team dedicates a number of days to working on bugs each sprint. Bugs which have reproducers are also great for community contributions as they're well isolated. Sometimes we're not as lucky to have reproducers though, then a bugfix should also include a test reproducing the original error along with the fix.
- [failed](https://github.com/apache/incubator-pekko-grpc/labels/failed) - tickets indicate a Jenkins failure (for example from a nightly build). These tickets usually start with the `FAILED: ...` message, and include a stacktrace + link to the Jenkins failure. The tickets are collected and worked on with priority to keep the build stable and healthy. Often times it may be simple timeout issues (Jenkins boxes are slow), though sometimes real bugs are discovered this way.
- [bug](https://github.com/apache/pekko-grpc/labels/bug) - bugs take priority in being fixed above features. The core team dedicates a number of days to working on bugs each sprint. Bugs which have reproducers are also great for community contributions as they're well isolated. Sometimes we're not as lucky to have reproducers though, then a bugfix should also include a test reproducing the original error along with the fix.
- [failed](https://github.com/apache/pekko-grpc/labels/failed) - tickets indicate a Jenkins failure (for example from a nightly build). These tickets usually start with the `FAILED: ...` message, and include a stacktrace + link to the Jenkins failure. The tickets are collected and worked on with priority to keep the build stable and healthy. Often times it may be simple timeout issues (Jenkins boxes are slow), though sometimes real bugs are discovered this way.

Pull Request validation states:

Expand All @@ -45,8 +45,8 @@ If you are running on JDK 8, you will need to use at least version 1.8.0u251 to

# Pekko gRPC contributing guidelines

These guidelines apply to all Pekko projects, by which we mean both the `apache/incubator-pekko` repository,
as well as any plugins or additional repos located under the Apache Pekko GitHub organisation, e.g. `apache/incubator-pekko-grpc` and others.
These guidelines apply to all Pekko projects, by which we mean both the `apache/pekko` repository,
as well as any plugins or additional repos located under the Apache Pekko GitHub organisation, e.g. `apache/pekko-grpc` and others.

These guidelines are meant to be a living document that should be changed and adapted as needed.
We encourage changes that make it easier to achieve our goals in an efficient way.
Expand All @@ -59,9 +59,9 @@ You can read its full text here: [ASF Code of Conduct](https://www.apache.org/fo
The below steps are how to get a patch into a main development branch (e.g. `main`).
The steps are exactly the same for everyone involved in the project (be it core team, or first time contributor).

1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/incubator-pekko-grpc/issues) and [existing pull requests](https://github.com/apache/incubator-pekko-grpc/pulls) for existing work.
- If there is no ticket yet, feel free to [create one](https://github.com/apache/incubator-pekko-grpc/issues/new) to discuss the problem and the approach you want to take to solve it.
1. [Fork the project](https://github.com/apache/incubator-pekko-grpc#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a PullRequest against the mainline Pekko-gRPC.
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/pekko-grpc/issues) and [existing pull requests](https://github.com/apache/pekko-grpc/pulls) for existing work.
- If there is no ticket yet, feel free to [create one](https://github.com/apache/pekko-grpc/issues/new) to discuss the problem and the approach you want to take to solve it.
1. [Fork the project](https://github.com/apache/pekko-grpc#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a PullRequest against the mainline Pekko-gRPC.
1. Create a branch on your fork and work on the feature. For example: `git checkout -b wip-custom-headers-pekko-grpc`
- Please make sure to follow the general quality guidelines (specified below) when developing your patch.
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your Pull Request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
Expand Down Expand Up @@ -268,7 +268,7 @@ There is a number of ways timeouts can be defined in Pekko tests. The following

Special care should be given `expectNoMessage` calls, which indeed will wait the entire timeout before continuing, therefore a shorter timeout should be used in those, for example `200` or `300.millis`.

You can read up on remaining and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/testkit/src/main/scala/org/apache/pekko/testkit/TestKit.scala)
You can read up on remaining and friends in [TestKit.scala](https://github.com/apache/pekko/blob/main/testkit/src/main/scala/org/apache/pekko/testkit/TestKit.scala)

# Supporting infrastructure

Expand All @@ -279,5 +279,5 @@ pekko-grpc currently uses Github Actions for Continuous Integration. See the `Ch
## Related links

* [Apache Contributor License Agreement](https://www.apache.org/licenses/contributor-agreements.html)
* [Pekko gRPC Issue Tracker](https://github.com/apache/incubator-pekko-grpc/issues)
* [Pekko gRPC Issue Tracker](https://github.com/apache/pekko-grpc/issues)
* [Scalariform](https://github.com/daniel-trinh/scalariform)
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) gRPC
Apache Pekko gRPC
Copyright 2022, 2023 The Apache Software Foundation

This product includes software developed at
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ See the note in the [Akka HTTP docs](https://doc.akka.io/docs/akka-http/10.1/ser

### 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-grpc) 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-grpc) 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.12)
- `sbt +compile` will compile for all supported versions of Scala
Expand Down
4 changes: 2 additions & 2 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import sbt.Keys.scalaVersion
// pekkoInlineEnabled should be set to true when we start building 1.1.x builds
ThisBuild / pekkoInlineEnabled := false
sourceDistName := "apache-pekko-grpc"
sourceDistIncubating := true
sourceDistIncubating := false
ThisBuild / versionScheme := Some(VersionScheme.SemVerSpec)
ThisBuild / resolvers += Resolver.ApacheMavenStagingRepo

Expand Down Expand Up @@ -226,7 +226,7 @@ lazy val docs = Project(id = "docs", base = file("docs"))
.settings(
name := s"$pekkoPrefix-docs",
makeSite := makeSite.dependsOn(LocalRootProject / ScalaUnidoc / doc).value,
pekkoParadoxGithub := Some("https://github.com/apache/incubator-pekko-grpc"),
pekkoParadoxGithub := Some("https://github.com/apache/pekko-grpc"),
previewPath := (Paradox / siteSubdirName).value,
Preprocess / siteSubdirName := s"api/pekko-grpc/${projectInfoVersion.value}",
Preprocess / sourceDirectory := (LocalRootProject / ScalaUnidoc / unidoc / target).value,
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/client/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Consuming Services (Client)

See the Pekko gRPC Quickstart project (available for [Scala](https://github.com//apache/incubator-pekko-grpc-quickstart-scala.g8/) and [Java](https://github.com//apache/incubator-pekko-grpc-quickstart-java.g8/)) to get started quickly.
See the Pekko gRPC Quickstart project (available for [Scala](https://github.com//apache/pekko-grpc-quickstart-scala.g8/) and [Java](https://github.com//apache/pekko-grpc-quickstart-java.g8/)) to get started quickly.

@@ toc

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Apache Pekko gRPC Quickstart

To try out Pekko gRPC and understand how the development process might work out, try the [Pekko gRPC Quickstart with Scala](https://github.com//apache/incubator-pekko-grpc-quickstart-scala.g8/) or the [Pekko gRPC Quickstart with Java](https://github.com//apache/incubator-pekko-grpc-quickstart-java.g8/).
To try out Pekko gRPC and understand how the development process might work out, try the [Pekko gRPC Quickstart with Scala](https://github.com//apache/pekko-grpc-quickstart-scala.g8/) or the [Pekko gRPC Quickstart with Java](https://github.com//apache/pekko-grpc-quickstart-java.g8/).

## Video Introduction

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/paradox/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ A minor bug fix and dependency change release.

### Bug Fixes

* Revert Netty SSL Context change that was added in akka-grpc 2.1.6 that broke the support for Netty with custom SSL Contexts ([PR200](https://github.com/apache/incubator-pekko-grpc/pull/200))
* Revert Netty SSL Context change that was added in akka-grpc 2.1.6 that broke the support for Netty with custom SSL Contexts ([PR200](https://github.com/apache/pekko-grpc/pull/200))

### Dependency Upgrades

* Use sbt-twirl from `org.playframework.twirl`, the new groupId for Play Twirl releases ([PR196](https://github.com/apache/incubator-pekko-grpc/pull/196))
* Use sbt-twirl from `org.playframework.twirl`, the new groupId for Play Twirl releases ([PR196](https://github.com/apache/pekko-grpc/pull/196))

## 1.0.1

Expand All @@ -19,7 +19,7 @@ there are security issues published for those versions.

### Additions

* Release Scala 2.13 and Scala 3 versions of pekko-grpc-codegen. This jar is used as a sbt plugin but it is useful to also support other Scala versions so other build frameworks can use use it ([`#180`](https://github.com/apache/incubator-pekko-grpc/issues/180)).
* Release Scala 2.13 and Scala 3 versions of pekko-grpc-codegen. This jar is used as a sbt plugin but it is useful to also support other Scala versions so other build frameworks can use use it ([`#180`](https://github.com/apache/pekko-grpc/issues/180)).

### Dependency Upgrades

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/server/grpc-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ services generated with older versions of Pekko gRPC.

There may be missing features and bugs in the current implementation. If you
encounter any, you are welcome to share a reproducer in our
[issue tracker](https://github.com/apache/incubator-pekko-grpc/issues).
[issue tracker](https://github.com/apache/pekko-grpc/issues).

@@@

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/server/reflection.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ services generated with older versions of Pekko gRPC.

There may be missing features and bugs in the current implementation. If you
encounter any, you are welcome to share a reproducer in our
[issue tracker](https://github.com/apache/incubator-pekko-grpc/issues).
[issue tracker](https://github.com/apache/pekko-grpc/issues).

@@@

Expand Down
6 changes: 3 additions & 3 deletions gradle-plugin/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ publishing {
developer {
id = 'contributors'
name = 'Contributors'
url = 'https://github.com/apache/incubator-pekko-grpc/graphs/contributors'
url = 'https://github.com/apache/pekko-grpc/graphs/contributors'
email = '[email protected]'
}
}
scm {
connection = '[email protected]:apache/incubator-pekko-grpc'
url = 'https://github.com/apache/incubator-pekko-grpc'
connection = '[email protected]:apache/pekko-grpc'
url = 'https://github.com/apache/pekko-grpc'
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions project/Common.scala
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ object Common extends AutoPlugin {
override def globalSettings =
Seq(
homepage := Some(url("https://pekko.apache.org//")),
scmInfo := Some(ScmInfo(url("https://github.com/apache/incubator-pekko-grpc"),
"[email protected]:apache/incubator-pekko-grpc")),
scmInfo := Some(ScmInfo(url("https://github.com/apache/pekko-grpc"),
"[email protected]:apache/pekko-grpc")),
developers += Developer(
"contributors",
"Contributors",
"[email protected]",
url("https://github.com/apache/incubator-pekko-grpc/graphs/contributors")),
url("https://github.com/apache/pekko-grpc/graphs/contributors")),
description := "Apache Pekko gRPC - Support for building streaming gRPC servers and clients on top of Pekko Streams.")

override lazy val projectSettings = Seq(
Expand Down Expand Up @@ -89,7 +89,7 @@ object Common extends AutoPlugin {
(ThisBuild / baseDirectory).value.toString,
"-doc-source-url", {
val branch = if (isSnapshot.value) "main" else s"v${version.value}"
s"https://github.com/apache/incubator-pekko-grpc/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
s"https://github.com/apache/pekko-grpc/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
},
"-doc-canonical-base-url",
"https://pekko.apache.org/api/pekko-grpc/current/") ++ (
Expand Down
3 changes: 1 addition & 2 deletions project/MetaInfLicenseNoticeCopy.scala
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ object MetaInfLicenseNoticeCopy extends AutoPlugin {
override def requires = ApacheSonatypePlugin

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

lazy val runtimeSettings = Seq(
apacheSonatypeLicenseFile := baseDir.value / "legal" / "RuntimeLicense.txt")
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._
/**
* Generate version.conf file 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
6 changes: 3 additions & 3 deletions project/project-info.conf
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ project-info {
text: "Snapshots are available from Apache Snapshots Repository"
}
issues: {
url: "https://github.com/apache/incubator-pekko-grpc/issues"
url: "https://github.com/apache/pekko-grpc/issues"
text: "GitHub issues"
}
release-notes: {
url: "https://github.com/apache/incubator-pekko-grpc/releases"
url: "https://github.com/apache/pekko-grpc/releases"
text: "GitHub releases"
}
api-docs: [
Expand All @@ -31,7 +31,7 @@ project-info {
}
{
text: "Github Discussions"
url: "https://github.com/apache/incubator-pekko-grpc/discussions"
url: "https://github.com/apache/pekko-grpc/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 @@ -19,7 +19,7 @@ site-link-validator {

ignore-prefixes = [
# GitHub will block with "429 Too Many Requests"
"https://github.com/apache/incubator-pekko-grpc/"
"https://github.com/apache/pekko-grpc/"
# MVN repository forbids access after a few requests
"https://mvnrepository.com/artifact/"
# Github links generated by sbt-license-report
Expand Down
Loading