Skip to content

Commit

Permalink
Minor infra fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ennru committed Nov 25, 2021
1 parent 335e2f4 commit 39ad765
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ categories:
label: 'p:google-fcm'
- title: 'HBase'
label: 'p:hbase'
- title: 'Huawei Push Kit'
label: 'p:huawei-push-kit'
- title: 'InfluxDB'
label: 'p:influxdb'
- title: 'IronMQ'
Expand Down Expand Up @@ -99,8 +101,6 @@ change-template: '- $TITLE [#$NUMBER](https://github.com/akka/alpakka/issues/$NU
template: |
# :mega: Alpakka $NEXT_PATCH_VERSION released!
### See the full Release Notes in the [Alpakka documentation](https://doc.akka.io/docs/alpakka/3.0/release-notes/3.0.x.html).
## Changes
$CHANGES
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ lazy val hbase = alpakkaProject("hbase", "hbase", Dependencies.HBase, Test / for
lazy val hdfs = alpakkaProject("hdfs", "hdfs", Dependencies.Hdfs)

lazy val huaweiPushKit =
alpakkaProject("huawei-push-kit", "huawei.pushkit", Dependencies.HuaweiPushKit, fatalWarnings := true)
alpakkaProject("huawei-push-kit", "huawei.pushkit", Dependencies.HuaweiPushKit)
.disablePlugins(MimaPlugin)

lazy val influxdb = alpakkaProject("influxdb", "influxdb", Dependencies.InfluxDB)
Expand Down
18 changes: 9 additions & 9 deletions docs/src/main/paradox/huawei-push-kit.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# HUAWEI Push Kit
# Huawei Push Kit

@@@ note { title="HUAWEI Push Kit" }
@@@ note { title="Huawei Push Kit" }

HUAWEI Push Kit is a messaging service provided for you. It establishes a messaging channel from the cloud to devices. By integrating Push Kit, you can send messages to your apps on users' devices in real time.
Huawei Push Kit is a messaging service provided for you. It establishes a messaging channel from the cloud to devices. By integrating Push Kit, you can send messages to your apps on users' devices in real time.

@@@

The Alpakka HUAWEI Push Kit connector provides a way to send notifications with [HUAWEI Push Kit](https://developer.huawei.com/consumer/en/hms/huawei-pushkit).
The Alpakka Huawei Push Kit connector provides a way to send notifications with [Huawei Push Kit](https://developer.huawei.com/consumer/en/hms/huawei-pushkit).

@@project-info{ projectId="huawei-push-kit" }

Expand Down Expand Up @@ -37,11 +37,11 @@ The table below shows direct dependencies of this module and the second tab show

## Settings

All of the configuration settings for HUAWEI Push Kit can be found in the @github[reference.conf](/huawei-push-kit/src/main/resources/reference.conf).
All of the configuration settings for Huawei Push Kit can be found in the @github[reference.conf](/huawei-push-kit/src/main/resources/reference.conf).

@@snip [snip](/huawei-push-kit/src/test/resources/application.conf) { #init-credentials }

The `test` and `maxConcurrentConnections` parameters in [HmsSettings](akka.stream.alpakka.huawei.pushkit.HmsSettings) are the predefined values.
The `test` and `maxConcurrentConnections` parameters in @scaladoc[HmsSettings](akka.stream.alpakka.huawei.pushkit.HmsSettings) are the predefined values.
You can send test notifications [(so called validate only).](https://developer.huawei.com/consumer/en/doc/development/HMSCore-References-V5/https-send-api-0000001050986197-V5)
And you can set the number of maximum concurrent connections.

Expand All @@ -58,7 +58,7 @@ Java
With this type of send you can get responses from the server.
These responses can be @scaladoc[PushKitResponse](akka.stream.alpakka.huawei.pushkit.PushKitResponse) or @scaladoc[ErrorResponse](akka.stream.alpakka.huawei.pushkit.ErrorResponse).
You can choose what you want to do with this information, but keep in mind
if you try to resend the failed messages you will need to use exponential backoff! (see [Akka docs `RestartFlow.onFailuresWithBackoff`](https://doc.akka.io/docs/akka/current/stream/operators/RestartFlow/onFailuresWithBackoff.html))
if you try to resend the failed messages you will need to use exponential backoff! (see @extref[[Akka docs `RestartFlow.onFailuresWithBackoff`](akka:stream/operators/RestartFlow/onFailuresWithBackoff.html))

If you don't care if the notification was sent successfully, you may use `fireAndForget`.

Expand All @@ -76,7 +76,7 @@ To help the integration and error handling or logging, there is a variation of t

You can build notification described in the original documentation.
It can be done by hand, or using some builder method.
Example is condition builder.
See an example of the condition builder below.

Scala
: @@snip [snip](/huawei-push-kit/src/test/scala/docs/scaladsl/PushKitExamples.scala) { #condition-builder }
: @@snip [snip](/huawei-push-kit/src/test/scala/docs/scaladsl/PushKitExamples.scala) { #condition-builder }
2 changes: 1 addition & 1 deletion docs/src/main/paradox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The [Alpakka project](https://doc.akka.io/docs/alpakka/current/) is an open sour
* [gRPC](external/grpc.md)
* [Hadoop Distributed File System](hdfs.md)
* [HBase](hbase.md)
* [HUAWEI Push Kit](huawei-push-kit.md)
* [Huawei Push Kit](huawei-push-kit.md)
* [HTTP](external/http.md)
* [IBM Bluemix Cloud Object storage](bluemix-cos.md)
* [IBM DB2 Event Store](external/db2-event-store.md)
Expand Down
6 changes: 3 additions & 3 deletions project/project-info.conf
Original file line number Diff line number Diff line change
Expand Up @@ -444,14 +444,14 @@ project-info {
]
}
huawei-push-kit: ${project-info.shared-info} {
title: "Alpakka HUAWEI Push Kit"
title: "Alpakka Huawei Push Kit"
jpms-name: "akka.stream.alpakka.huawei.pushkit"
issues.url: ${project-info.labels}"huawei-push-kit"
levels: [
{
readiness: CommunityDriven
since: "2021-03-26"
since-version: "0.1"
since: "2021-11-25"
since-version: "3.0.4"
}
]
api-docs: [
Expand Down

0 comments on commit 39ad765

Please sign in to comment.