Merge pull request #62 from momentohq/docs-examples

chore: add examples for documentation

.github/workflows/ci.yml

@@ -77,3 +77,35 @@ jobs:
         with:
           api-level: ${{ matrix.api-level }}
           script: ./gradlew connectedCheck
+
+  examples:
+    runs-on: ubuntu-latest
+    env:
+      MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: 'corretto'
+
+      - name: Run doc examples
+        id: validation
+        run: |
+          cd examples
+          ./gradlew docExamples readmeExample cheatSheetExample basic
+
+      - name: Send CI failure mail
+        if: ${{ steps.validation.outcome == 'failure' }}
+        uses: momentohq/standards-and-practices/github-actions/error-email-action@gh-actions-v1
+        with:
+          username: ${{secrets.MOMENTO_ROBOT_GMAIL_USERNAME}}
+          password: ${{secrets.MOMENTO_ROBOT_GMAIL_PASSWORD}}
+
+      - name: Flag Job Failure
+        if: ${{ steps.validation.outcome == 'failure' }}
+        run: exit 1

.github/workflows/on-push-to-main-branch.yml

@@ -16,8 +16,8 @@ jobs:
       - name: Generate README
         uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2
         with:
-          project_status: incubating
-          project_stability: alpha
+          project_status: official
+          project_stability: beta
           project_type: sdk
           sdk_language: Kotlin
           dev_docs_slug: kotlin

README.template.md

@@ -2,33 +2,23 @@
 
 ## Packages
 
-The Kotlin SDK is available on the Sonatype Central snapshots repo:
+The Kotlin SDK is available on Maven Central:
 
 ### Gradle
 
 ```kotlin
-repositories {
-    maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
-}
-
 dependencies {
-    implementation("software.momento.kotlin:sdk:0.1.0-SNAPSHOT")
+    implementation("software.momento.kotlin:sdk:0.1.3")
 }
 ```
 
 ### Maven
 
 ```xml
-<repository>
-    <id>sonatype-snapshots</id>
-    <name>Sonatype Snapshots</name>
-    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
-</repository>
-
 <dependency>
     <groupId>software.momento.kotlin</groupId>
     <artifactId>sdk</artifactId>
-    <version>0.1.0-SNAPSHOT</version>
+    <version>0.1.3</version>
 </dependency>
 ```
 

examples/.gitignore

@@ -0,0 +1,42 @@
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

examples/README.md

@@ -0,0 +1,15 @@
+# Kotlin Client SDK
+
+<br>
+
+## Running the Examples
+
+- You do not need gradle to be installed
+- JDK 11 or above is required to run the example
+- To get started with Momento you will need a Momento API key. You can get one from the
+  [Momento Console](https://console.gomomento.com).
+
+### Basic
+```bash
+MOMENTO_API_KEY=<YOUR API KEY> ./gradlew basic
+```

examples/build.gradle.kts

@@ -0,0 +1,43 @@
+plugins {
+    kotlin("jvm") version "1.9.22"
+}
+
+group = "software.momento.kotlin"
+version = "1.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("software.momento.kotlin:sdk:0.1.3")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
+}
+
+kotlin {
+    jvmToolchain(8)
+}
+
+tasks.register<JavaExec>("basic") {
+    description = "Run the basic example"
+    classpath = sourceSets["main"].runtimeClasspath
+    mainClass = "software.momento.example.BasicExampleKt"
+}
+
+tasks.register<JavaExec>("docExamples") {
+    description = "Run the doc examples"
+    classpath = sourceSets["main"].runtimeClasspath
+    mainClass = "software.momento.example.doc_examples.DocExamplesKt"
+}
+
+tasks.register<JavaExec>("readmeExample") {
+    description = "Run the readme example"
+    classpath = sourceSets["main"].runtimeClasspath
+    mainClass = "software.momento.example.doc_examples.ReadmeExampleKt"
+}
+
+tasks.register<JavaExec>("cheatSheetExample") {
+    description = "Run the cheat sheet example"
+    classpath = sourceSets["main"].runtimeClasspath
+    mainClass = "software.momento.example.doc_examples.CheatSheetKt"
+}

examples/gradle.properties

@@ -0,0 +1 @@
+kotlin.code.style=official

examples/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists