Skip to content

Commit

Permalink
! update after release v1.0.0-Alpha4
Browse files Browse the repository at this point in the history
  • Loading branch information
oldratlee committed May 6, 2024
1 parent 650a36c commit 6f9d723
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 27 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<a href="https://openjdk.java.net/"><img src="https://img.shields.io/badge/Java-8+-339933?logo=openjdk&logoColor=white" alt="Java support"></a>
<a href="https://kotlinlang.org"><img src="https://img.shields.io/badge/Kotlin-1.6+-7F52FF.svg?logo=kotlin&logoColor=white" alt="Kotlin"></a>
<a href="https://www.apache.org/licenses/LICENSE-2.0.html"><img src="https://img.shields.io/github/license/foldright/cffu?color=4D7A97&logo=apache" alt="License"></a>
<a href="https://foldright.io/cffu/apidocs/"><img src="https://img.shields.io/github/release/foldright/cffu?label=javadoc&color=339933&logo=microsoft-academic&logoColor=white" alt="Javadocs"></a>
<a href="https://foldright.io/cffu/dokka/"><img src="https://img.shields.io/github/release/foldright/cffu?label=dokka&color=339933&logo=kotlin&logoColor=white" alt="dokka"></a>
<a href="https://foldright.io/api-docs/cffu/"><img src="https://img.shields.io/github/release/foldright/cffu?label=javadoc&color=339933&logo=microsoft-academic&logoColor=white" alt="Javadocs"></a>
<a href="https://foldright.io/api-docs/cffu-kotlin/"><img src="https://img.shields.io/github/release/foldright/cffu?label=dokka&color=339933&logo=kotlin&logoColor=white" alt="dokka"></a>
<a href="https://central.sonatype.com/artifact/io.foldright/cffu/0.9.0/versions"><img src="https://img.shields.io/maven-central/v/io.foldright/cffu?logo=apache-maven&logoColor=white" alt="Maven Central"></a>
<a href="https://github.com/foldright/cffu/releases"><img src="https://img.shields.io/github/release/foldright/cffu.svg" alt="GitHub Releases"></a>
<a href="https://github.com/foldright/cffu/stargazers"><img src="https://img.shields.io/github/stars/foldright/cffu?style=flat" alt="GitHub Stars"></a>
Expand Down Expand Up @@ -524,8 +524,8 @@ public class ConcurrencyStrategyDemo {
可以参见:

- `API`文档
- [`Java API`文档](https://foldright.io/cffu/apidocs/)
- [`Kotlin API`文档](https://foldright.io/cffu/dokka/)
- [`Java API`文档](https://foldright.io/api-docs/cffu/)
- [`Kotlin API`文档](https://foldright.io/api-docs/cffu-kotlin/)
- 实现源码
- `cffu`[`Cffu.java`](cffu-core/src/main/java/io/foldright/cffu/Cffu.java)[`CffuFactory.java`](cffu-core/src/main/java/io/foldright/cffu/CffuFactory.java)
- `CompletableFuture utils`[`CompletableFutureUtils.java`](cffu-core/src/main/java/io/foldright/cffu/CompletableFutureUtils.java)
Expand All @@ -545,8 +545,8 @@ public class ConcurrencyStrategyDemo {

# 🔌 API Docs

- 当前版本的`Java API`文档: https://foldright.io/cffu/apidocs/
- 当前版本的`Kotlin API`文档: https://foldright.io/cffu/dokka/
- 当前版本的`Java API`文档: https://foldright.io/api-docs/cffu/
- 当前版本的`Kotlin API`文档: https://foldright.io/api-docs/cffu-kotlin/

代码示例:

Expand All @@ -561,18 +561,18 @@ public class ConcurrencyStrategyDemo {
<dependency>
<groupId>io.foldright</groupId>
<artifactId>cffu</artifactId>
<version>1.0.0-Alpha3</version>
<version>1.0.0-Alpha4</version>
</dependency>
```
- For `Gradle` projects:

```groovy
// Gradle Kotlin DSL
implementation("io.foldright:cffu:1.0.0-Alpha3")
implementation("io.foldright:cffu:1.0.0-Alpha4")
```
```groovy
// Gradle Groovy DSL
implementation 'io.foldright:cffu:1.0.0-Alpha3'
implementation 'io.foldright:cffu:1.0.0-Alpha4'
```
- `cffu Kotlin`支持库:
- For `Maven` projects:
Expand All @@ -581,18 +581,18 @@ public class ConcurrencyStrategyDemo {
<dependency>
<groupId>io.foldright</groupId>
<artifactId>cffu-kotlin</artifactId>
<version>1.0.0-Alpha3</version>
<version>1.0.0-Alpha4</version>
</dependency>
```
- For `Gradle` projects:

```groovy
// Gradle Kotlin DSL
implementation("io.foldright:cffu-kotlin:1.0.0-Alpha3")
implementation("io.foldright:cffu-kotlin:1.0.0-Alpha4")
```
```groovy
// Gradle Groovy DSL
implementation 'io.foldright:cffu-kotlin:1.0.0-Alpha3'
implementation 'io.foldright:cffu-kotlin:1.0.0-Alpha4'
```
- `cffu bom`:
- For `Maven` projects:
Expand All @@ -601,7 +601,7 @@ public class ConcurrencyStrategyDemo {
<dependency>
<groupId>io.foldright</groupId>
<artifactId>cffu-bom</artifactId>
<version>1.0.0-Alpha3</version>
<version>1.0.0-Alpha4</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -610,11 +610,11 @@ public class ConcurrencyStrategyDemo {

```groovy
// Gradle Kotlin DSL
implementation(platform("io.foldright:cffu-bom:1.0.0-Alpha3"))
implementation(platform("io.foldright:cffu-bom:1.0.0-Alpha4"))
```
```groovy
// Gradle Groovy DSL
implementation platform('io.foldright:cffu-bom:1.0.0-Alpha3')
implementation platform('io.foldright:cffu-bom:1.0.0-Alpha4')
```
- [📌 `TransmittableThreadLocal(TTL)`](https://github.com/alibaba/transmittable-thread-local)的[`cffu executor wrapper SPI`实现](cffu-ttl-executor-wrapper):
- For `Maven` projects:
Expand All @@ -623,19 +623,19 @@ public class ConcurrencyStrategyDemo {
<dependency>
<groupId>io.foldright</groupId>
<artifactId>cffu-ttl-executor-wrapper</artifactId>
<version>1.0.0-Alpha3</version>
<version>1.0.0-Alpha4</version>
<scope>runtime</scope>
</dependency>
```
- For `Gradle` projects:

```groovy
// Gradle Kotlin DSL
runtimeOnly("io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha3")
runtimeOnly("io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha4")
```
```groovy
// Gradle Groovy DSL
runtimeOnly 'io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha3'
runtimeOnly 'io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha4'
```

# 📚 更多资料
Expand Down
2 changes: 1 addition & 1 deletion cffu-kotlin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
</documentedVisibilities>
<externalDocumentationLinks>
<link>
<url>https://foldright.io/cffu/apidocs/${project.version}/</url>
<url>https://foldright.io/api-docs/cffu/${project.version}/</url>
<packageListUrl>file://${javadoc.package.list.dir}/cffu/package-list</packageListUrl>
</link>
<link>
Expand Down
6 changes: 3 additions & 3 deletions cffu-ttl-executor-wrapper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ For `Maven` projects:
<groupId>io.foldright</groupId>
<artifactId>cffu-ttl-executor-wrapper</artifactId>
<scope>runtime</scope>
<version>1.0.0-Alpha3</version>
<version>1.0.0-Alpha4</version>
</dependency>
```

For `Gradle` projects:

```groovy
// Gradle Kotlin DSL
runtimeOnly("io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha3")
runtimeOnly("io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha4")
```

```groovy
// Gradle Groovy DSL
runtimeOnly 'io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha3'
runtimeOnly 'io.foldright:cffu-ttl-executor-wrapper:1.0.0-Alpha4'
```

`cffu-ttl-executor-wrapper` has published to maven central, find the latest version at
Expand Down
8 changes: 5 additions & 3 deletions scripts/maven_deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ jvu::switch_to_jdk 21
########################################
# integration test
########################################
rm -rf "$HOME/.m2/repository/io/foldright"/cffu*
cu::log_then_run scripts/integration_test
cu::log_then_run demos/scripts/integration_test
if [ "${1:-}" = -it ]; then
rm -rf "$HOME/.m2/repository/io/foldright"/cffu*
cu::log_then_run scripts/integration_test
cu::log_then_run demos/scripts/integration_test
fi

########################################
# maven deploy
Expand Down
2 changes: 0 additions & 2 deletions src/main/javadoc/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,5 @@
a tiny sidekick library for
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/CompletableFuture.html"><code>CompletableFuture</code></a>
to improve user experience and reduce misuse.
<p>The <a href="https://github.com/foldright/cffu" target="_blank"><dfn>CF-Fu</dfn> GitHub repo</a>
also include the best practice/traps guide 📚 for <code>CompletableFuture</code> 💗.
</body>
</html>

0 comments on commit 6f9d723

Please sign in to comment.