Skip to content

Commit c907e1c

Browse files
update example project links in readmes and archives
1 parent 00262ee commit c907e1c

File tree

9 files changed

+43
-16
lines changed

9 files changed

+43
-16
lines changed

.github/workflows/archive-examples.yml

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
- master
77
paths:
88
- 'examples/android-example/**'
9-
- 'examples/kotlin-dataframe-plugin-example/**'
9+
- 'examples/kotlin-dataframe-plugin-gradle-example/**'
10+
- 'examples/kotlin-dataframe-plugin-maven-example/**'
1011
workflow_dispatch:
1112

1213
jobs:
@@ -22,10 +23,16 @@
2223
cd examples/android-example
2324
zip -r ../../android-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*"
2425
25-
- name: Create kotlin-dataframe-plugin-example archive
26+
- name: Create kotlin-dataframe-plugin-gradle-example archive
2627
run: |
27-
cd examples/kotlin-dataframe-plugin-example
28-
zip -r ../../kotlin-dataframe-plugin-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*"
28+
cd examples/kotlin-dataframe-plugin-gradle-example
29+
zip -r ../../kotlin-dataframe-plugin-gradle-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*"
30+
31+
- name: Create kotlin-dataframe-plugin-maven-example archive
32+
run: |
33+
cd examples/kotlin-dataframe-plugin-maven-example
34+
zip -r ../../kotlin-dataframe-plugin-maven-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*"
35+
2936
3037
- name: Checkout example-projects-archives branch
3138
run: |
@@ -58,10 +65,15 @@
5865
5966
**Download:** [android-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/android-example.zip)
6067
61-
### Kotlin DataFrame Plugin Example
62-
Example of using the compiler plugin for Kotlin DataFrame.
68+
### Kotlin DataFrame Plugin Gradle Example
69+
Example of using the compiler plugin for Kotlin DataFrame in Gradle project.
70+
71+
**Download:** [kotlin-dataframe-plugin-gradle-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-gradle-example.zip)
72+
73+
### Kotlin DataFrame Plugin Maven Example
74+
Example of using the compiler plugin for Kotlin DataFrame in Gradle project.
6375
64-
**Download:** [kotlin-dataframe-plugin-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-example.zip)
76+
**Download:** [kotlin-dataframe-plugin-maven-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-maven-example.zip)
6577
6678
---
6779

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ for Groovy, and for configurations specific to Android projects.
146146
147147
This example of Kotlin DataFrame code with
148148
the [Compiler Plugin](https://kotlin.github.io/dataframe/compiler-plugin.html) enabled.
149-
See [the full project](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-example).
149+
See [the full project](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-gradle-example).
150150
See also
151151
[this example in Kotlin Notebook](https://github.com/Kotlin/dataframe/tree/master/examples/notebooks/readme_example.ipynb).
152152

build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ tasks.assemble {
324324
// subprojects use the Gradle version from the root project, so let's sync them to ensure standalone version will build as well.
325325
doLast {
326326
val source = file("gradle/wrapper/gradle-wrapper.properties")
327-
listOf("examples/android-example", "examples/kotlin-dataframe-plugin-example").forEach { sub ->
327+
listOf("examples/android-example", "examples/kotlin-dataframe-plugin-gradle-example").forEach { sub ->
328328
val target = file("$sub/gradle/wrapper/gradle-wrapper.properties")
329329
if (source.readText() != target.readText()) {
330330
source.copyTo(target, overwrite = true)

docs/StardustDocs/topics/Compiler-Plugin.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@ fun main() {
164164

165165
## Examples
166166

167-
* [Kotlin DataFrame in the IntelliJ IDEA project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-example)
168-
— an IntelliJ IDEA project showcasing simple DataFrame expressions using the Compiler Plugin.
167+
* [Kotlin DataFrame in the IntelliJ IDEA Gradle project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example)
168+
— an IntelliJ IDEA Gradle project showcasing simple DataFrame expressions using the Compiler Plugin.
169+
* [Kotlin DataFrame in the IntelliJ IDEA Maven project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-maven-example)
170+
— an IntelliJ IDEA Maven project showcasing simple DataFrame expressions using the Compiler Plugin.
169171
* [](compilerPluginExamples.md) — few examples of Compiler Plugin usages.

docs/StardustDocs/topics/compilerPluginExamples.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
This page provides a few examples that you can copy directly to your project.
44
[Schema info](staticInterpretation.md#schema-info) will be a convenient way to observe the result of different operations.
55

6-
> See also an [IntelliJ IDEA project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-example),
6+
> See also an
7+
> [IntelliJ IDEA project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example),
78
> showcasing simple DataFrame expressions using the Compiler Plugin.
89
910
### Example 1

docs/StardustDocs/topics/extensionPropertiesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ df.rename { name }.into("firstName")
159159
.filter { firstName == "Nikita" }
160160
```
161161

162-
See [Compiler Plugin Example](https://github.com/Kotlin/dataframe/tree/plugin_example/examples/kotlin-dataframe-plugin-example)
162+
See [Compiler Plugin Example](https://github.com/Kotlin/dataframe/tree/plugin_example/examples/kotlin-dataframe-plugin-gradle-example)
163163
IDEA project with basic Extension Properties API examples.
164164
</tab>
165165
</tabs>

docs/StardustDocs/topics/guides/Guides-And-Examples.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,13 @@ and make working with your data both convenient and type-safe.
7070

7171
Explore our extensive collection of practical examples and real-world analytics workflows.
7272

73-
* [Kotlin DataFrame Compiler Plugin Example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-example)
74-
— a simple project demonstrating the usage of the [compiler plugin](Compiler-Plugin.md),
73+
* [Kotlin DataFrame Compiler Plugin Gradle Example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example)
74+
— a simple Gradle project demonstrating the usage of the [compiler plugin](Compiler-Plugin.md),
75+
showcasing DataFrame expressions with [extension properties](extensionPropertiesApi.md)
76+
that are generated on-the-fly in the IDEA project.
77+
78+
* [Kotlin DataFrame Compiler Plugin Maven Example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example)
79+
— a simple Maven project demonstrating the usage of the [compiler plugin](Compiler-Plugin.md),
7580
showcasing DataFrame expressions with [extension properties](extensionPropertiesApi.md)
7681
that are generated on-the-fly in the IDEA project.
7782

examples/kotlin-dataframe-plugin-gradle-example/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ as well as the latest Kotlin plugin version.
99
> [!WARNING]
1010
> For proper functionality in IntelliJ IDEA requires version 2025.2 or newer.
1111
12-
[Download Kotlin DataFrame Compiler Plugin Gradle Example](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-example.zip)
12+
[Download Kotlin DataFrame Compiler Plugin Gradle Example](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-gradle-example.zip)
13+
14+
See also [Kotlin DataFrame Compiler Maven Plugin Example](../kotlin-dataframe-plugin-maven-example)

examples/kotlin-dataframe-plugin-maven-example/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,8 @@ as well as the latest Kotlin plugin version.
88

99
> [!WARNING]
1010
> For proper functionality in IntelliJ IDEA requires version 2025.3 or newer.
11+
12+
> [Download Kotlin DataFrame Compiler Plugin Maven Example](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-maven-example.zip)
13+
14+
15+
See also [Kotlin DataFrame Compiler Gradle Plugin Example](../kotlin-dataframe-plugin-gradle-example)

0 commit comments

Comments
 (0)