From a1ef7e974ecaedd237749f79b2fe8e6e3248ea40 Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Mon, 25 Mar 2024 09:48:18 +0100 Subject: [PATCH] chore: repo gardening (#1925) --- .fossa.yml | 1 + .github/autolabeler.yml | 5 -- .github/pr-labeler.yml | 1 - .github/release-drafter.yml | 24 ------- .github/release.yml | 21 ++++++ .github/workflows/build-test.yml | 84 ++++++++++++++++++------ .github/workflows/fossa.yml | 14 ++-- .github/workflows/link-validator.yml | 16 +++-- .github/workflows/native-image-tests.yml | 10 ++- .github/workflows/nightly.yml | 14 ++-- .github/workflows/pr-labeler.yml | 17 ----- .github/workflows/publish.yml | 33 +++++++--- .github/workflows/release-drafter.yml | 24 ------- CONTRIBUTING.md | 2 - README.md | 10 ++- docs/release-train-issue-template.md | 8 +-- project/plugins.sbt | 2 +- project/project-info.conf | 2 +- 18 files changed, 156 insertions(+), 132 deletions(-) delete mode 100644 .github/autolabeler.yml delete mode 100644 .github/pr-labeler.yml delete mode 100644 .github/release-drafter.yml create mode 100644 .github/release.yml delete mode 100644 .github/workflows/pr-labeler.yml delete mode 100644 .github/workflows/release-drafter.yml diff --git a/.fossa.yml b/.fossa.yml index 67dc75142..41e76bb30 100644 --- a/.fossa.yml +++ b/.fossa.yml @@ -6,5 +6,6 @@ paths: exclude: - benchmarks - interop-tests + - native-image-tests - plugin-tester-java - plugin-tester-scala diff --git a/.github/autolabeler.yml b/.github/autolabeler.yml deleted file mode 100644 index 3706f6153..000000000 --- a/.github/autolabeler.yml +++ /dev/null @@ -1,5 +0,0 @@ -update: ['/project/Dependencies.scala', '/project/plugins.sbt', '/project/build.properties'] -gradle: ['/gradle-plugin'] -maven: ['/maven-plugin'] -sbt: ['/sbt-plugin'] -codegen: ['/codegen'] diff --git a/.github/pr-labeler.yml b/.github/pr-labeler.yml deleted file mode 100644 index 995cbce5f..000000000 --- a/.github/pr-labeler.yml +++ /dev/null @@ -1 +0,0 @@ -update: ['update/*'] diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml deleted file mode 100644 index e9c2eda2d..000000000 --- a/.github/release-drafter.yml +++ /dev/null @@ -1,24 +0,0 @@ -# Config for https://github.com/toolmantim/release-drafter -name-template: 'Akka gRPC $NEXT_PATCH_VERSION' -tag-template: 'v$NEXT_PATCH_VERSION' -categories: - - title: 'Client side' - label: 'client' - - title: 'Server side' - label: 'server' - - title: 'Internal changes' - label: 'development' - - title: 'Gradle' - label: 'gradle' - - title: 'Maven' - label: 'maven' - - title: 'sbt' - label: 'sbt' - - title: 'Updates' - label: 'update' - -change-template: '- $TITLE [#$NUMBER](https://github.com/akka/akka-grpc/issues/$NUMBER) by [@$AUTHOR](https://github.com/$AUTHOR)' -template: | - ## Changes - - $CHANGES diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..d485ecc6e --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,21 @@ +# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes +changelog: + categories: + - title: 'Client side' + labels: + - 'client' + - title: 'Server side' + labels: + - 'server' + - title: 'Gradle' + labels: + - 'gradle' + - title: 'Maven' + labels: + - 'maven' + - title: 'sbt' + labels: + - 'sbt' + - title: 'Other' + labels: + - "*" diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml index 5a993192b..d9093770a 100644 --- a/.github/workflows/build-test.yml +++ b/.github/workflows/build-test.yml @@ -20,16 +20,22 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 @@ -43,16 +49,22 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 @@ -72,15 +84,21 @@ jobs: scalaVersion: [2.13, 3.3] steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11.0 @@ -107,15 +125,21 @@ jobs: scala-version: 3.3 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 @@ -129,15 +153,21 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 @@ -184,15 +214,21 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 @@ -229,15 +265,21 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yml index 0acfae12e..e9c955e65 100644 --- a/.github/workflows/fossa.yml +++ b/.github/workflows/fossa.yml @@ -12,19 +12,25 @@ jobs: fossa: name: Fossa runs-on: ubuntu-22.04 - if: github.repository == 'akka/akka-grpc' + if: github.event.repository.fork == false steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 17 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.17 diff --git a/.github/workflows/link-validator.yml b/.github/workflows/link-validator.yml index dc6d31df4..9b1fcb3f1 100644 --- a/.github/workflows/link-validator.yml +++ b/.github/workflows/link-validator.yml @@ -12,18 +12,24 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # fetch everything https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + - name: Set up JDK 17 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: - jvm: temurin:1.11 + jvm: temurin:1.17 apps: cs - name: sbt site diff --git a/.github/workflows/native-image-tests.yml b/.github/workflows/native-image-tests.yml index 414e9b7e6..9fb94c59d 100644 --- a/.github/workflows/native-image-tests.yml +++ b/.github/workflows/native-image-tests.yml @@ -14,7 +14,9 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 @@ -26,11 +28,13 @@ jobs: - name: Cache Coursier cache # https://github.com/coursier/cache-action/releases - uses: coursier/cache-action@v6.4.0 + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 # https://github.com/coursier/setup-action/releases - uses: coursier/setup-action@v1.3.4 + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 57639a0c1..b1686d29a 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -12,7 +12,7 @@ jobs: test: name: Run tests runs-on: ubuntu-22.04 - if: github.repository == 'akka/akka-grpc' + if: github.event.repository.fork == false strategy: fail-fast: false matrix: @@ -26,15 +26,21 @@ jobs: - { scalaVersion: "3.3", jdkVersion: "1.17.0", jvmName: "temurin:1.17.0", extraOpts: '' } steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK ${{ matrix.jdkVersion }} - uses: coursier/setup-action@v1.3.4 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: ${{ matrix.jvmName }} diff --git a/.github/workflows/pr-labeler.yml b/.github/workflows/pr-labeler.yml deleted file mode 100644 index 8c7b6272b..000000000 --- a/.github/workflows/pr-labeler.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: PR Labeler -on: - pull_request: - types: [opened] - -jobs: - pr-labeler: - permissions: - contents: read - pull-requests: write - runs-on: ubuntu-latest - steps: - # https://github.com/TimonVS/pr-labeler-action/releases - # v4.1.1 - - uses: TimonVS/pr-labeler-action@8b99f404a073744885d8021d1de4e40c6eaf38e2 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 914efdff3..4472303cc 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -6,6 +6,9 @@ on: - main tags: ["*"] +permissions: + contents: read + jobs: sbt: name: sbt publish @@ -13,16 +16,22 @@ jobs: if: github.event.repository.fork == false steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves fetch-depth: 0 - name: Cache Coursier cache - uses: coursier/cache-action@v6.4.0 + # https://github.com/coursier/cache-action/releases + # v6.4.5 + uses: coursier/cache-action@1ff273bff02a8787bc9f1877d347948af647956d - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11.0.17 @@ -40,16 +49,20 @@ jobs: name: Release gradle plugin runs-on: ubuntu-22.04 # only on tagged release, not snapshot - if: github.repository == 'akka/akka-grpc' && startsWith(github.ref, 'refs/tags/') + if: github.event.repository.fork == false && startsWith(github.ref, 'refs/tags/') steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves fetch-depth: 0 - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11.0.17 @@ -62,13 +75,17 @@ jobs: if: github.event.repository.fork == false steps: - name: Checkout - uses: actions/checkout@v3.1.0 + # https://github.com/actions/checkout/releases + # v4.1.1 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 with: # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves fetch-depth: 0 - name: Set up JDK 11 - uses: coursier/setup-action@v1.3.0 + # https://github.com/coursier/setup-action/releases + # v1.3.5 + uses: coursier/setup-action@7bde40eee928896f074dbb76d22dd772eed5c65f with: jvm: temurin:1.11 diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml deleted file mode 100644 index 75385cf15..000000000 --- a/.github/workflows/release-drafter.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Release Drafter - -on: - push: - # branches to consider in the event; optional, defaults to all - branches: [ main ] - -permissions: - contents: read - -jobs: - update_release_draft: - runs-on: ubuntu-22.04 - if: github.repository == 'akka/akka-grpc' - permissions: - contents: write - steps: - # Drafts your next Release notes as Pull Requests are merged - # https://github.com/release-drafter/release-drafter/releases - # v5.21.1 - - uses: release-drafter/release-drafter@6df64e4ba4842c203c604c1f45246c5863410adb - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fbccc8662..8033a9907 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,6 @@ You're always welcome to submit your PR straight away and start the discussion ( # The Akka Community -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). - You may also check out these [other resources](https://akka.io/get-involved/). # Navigating around the project & codebase diff --git a/README.md b/README.md index 0d404a089..3859473e7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# akka-grpc +# Akka gRPC Support for building streaming gRPC servers and clients on top of Akka Streams. @@ -6,6 +6,8 @@ of Akka Streams. This library is meant to be used as a building block in projects using the Akka toolkit. +The Akka family of projects is managed by teams at [Lightbend](https://lightbend.com/) with help from the community. + ## Documentation - [Akka gRPC reference](https://doc.akka.io/docs/akka-grpc/current/) documentation @@ -50,10 +52,6 @@ The project is split up in a number of subprojects: Additionally, 'plugin-tester-java' and 'plugin-tester-scala' contain an example project in Java and Scala respectively, with both sbt and Gradle configurations. -## Compatibility & support - -Support for Akka gRPC is available via the [Lightbend Subscription](https://lightbend.com/lightbend-subscription) - ## License -Akka gRPC is licensed under the Business Source License 1.1, see LICENSE. +Akka gRPC is licensed under the Business Source License 1.1, please see the [Akka License FAQ](https://www.lightbend.com/akka/license-faq). diff --git a/docs/release-train-issue-template.md b/docs/release-train-issue-template.md index a62cfbe52..c7ac6f383 100644 --- a/docs/release-train-issue-template.md +++ b/docs/release-train-issue-template.md @@ -47,9 +47,6 @@ Variables to be expanded in this template: For important patch releases, and only if critical issues have been fixed: - [ ] Send a release notification to [Lightbend discuss](https://discuss.akka.io) -- [ ] Tweet using the [@akkateam](https://twitter.com/akkateam/) account (or ask someone to) about the new release -- [ ] Announce on [Gitter akka/akka](https://gitter.im/akka/akka) -- [ ] Announce internally (with links to Tweet, discuss) For minor or major releases: @@ -57,9 +54,8 @@ For minor or major releases: ### Afterwards -- [ ] Update version for [Lightbend Supported Modules](https://developer.lightbend.com/docs/lightbend-platform/introduction/getting-help/build-dependencies.html) in [private project](https://github.com/lightbend/lightbend-technology-intro-doc/blob/master/docs/modules/getting-help/examples/build.sbt) -- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) -- [ ] Update [Akka Guide samples](https://github.com/akka/akka-platform-guide) +- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/docs/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies) +- [ ] Update [Akka Guide samples](https://github.com/lightbend/akka-guide) - [ ] Update [Akka Projection gRPC samples](https://github.com/akka/akka-projection/tree/main/samples/grpc) - [ ] Update quickstarts: - [ ] [Akka gRPC Java](https://github.com/akka/akka-grpc-quickstart-java.g8/blob/main/src/main/g8/default.properties) diff --git a/project/plugins.sbt b/project/plugins.sbt index 7174d7286..d2d47bf98 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -18,7 +18,7 @@ addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.7") addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.12") // docs -addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.54") +addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.55") addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-dependencies" % "0.2.4") addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.3") addSbtPlugin("com.github.sbt" % "sbt-site-paradox" % "1.5.0") diff --git a/project/project-info.conf b/project/project-info.conf index aff909232..f4376160a 100644 --- a/project/project-info.conf +++ b/project/project-info.conf @@ -1,7 +1,7 @@ project-info { version: "current" shared-info { - jdk-versions: ["Eclipse Temurin JDK 11", "Eclipse Temurin JDK 17"] + jdk-versions: ["Eclipse Temurin JDK 11", "Eclipse Temurin JDK 17", "Eclipse Temurin JDK 21"] snapshots: { url: "https://repo.akka.io/snapshots" text: "Akka library snapshot repository"