Merge pull request #688 from gsmet/codestarts

Add codestarts

Author: gsmet

.github/workflows/build.yml

@@ -60,5 +60,5 @@ jobs:
         key: maven-repo-pr-${{ runner.os }}-${{ steps.get-date.outputs.date }}
 
     - name: Build with Maven
-      run: mvn -B formatter:validate verify --file pom.xml
+      run: mvn -B formatter:validate install
 

command-airline/runtime/pom.xml

@@ -60,6 +60,26 @@
                     </annotationProcessorPaths>
                 </configuration>
             </plugin>
+            <plugin>
+                <artifactId>maven-jar-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>generate-codestart-jar</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                        <configuration>
+                            <classesDirectory>${project.basedir}/src/main</classesDirectory>
+                            <includes>
+                                <include>codestarts/**</include>
+                            </includes>
+                            <classifier>codestarts</classifier>
+                            <skipIfEmpty>true</skipIfEmpty>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>

command-airline/runtime/src/main/codestarts/quarkus/quarkiverse-github-app-command-airline-codestart/codestart.yml

@@ -0,0 +1,11 @@
+name: quarkiverse-github-app-command-airline-codestart
+ref: quarkiverse-github-app-command-airline
+metadata:
+  title: GitHub App Command Airline
+  description: Start coding comment-based commands.
+  related-guide-section: https://docs.quarkiverse.io/quarkus-github-app/dev/commands.html
+language:
+  base:
+    shared-data:
+      readme:
+        include-default-content: false

command-airline/runtime/src/main/codestarts/quarkus/quarkiverse-github-app-command-airline-codestart/java/src/main/java/org/acme/MyGitHubBot.java

@@ -0,0 +1,39 @@
+package org.acme;
+
+import java.io.IOException;
+import java.util.List;
+
+import org.kohsuke.github.GHEventPayload;
+
+import com.github.rvesse.airline.annotations.Arguments;
+import com.github.rvesse.airline.annotations.Cli;
+import com.github.rvesse.airline.annotations.Command;
+
+import io.quarkiverse.githubapp.command.airline.AbstractHelpCommand;
+
+// TODO: make sure you adjust the name as @bot is an actual GitHub user
+@Cli(name = "@bot", commands = { MyGitHubBot.SayHello.class, MyGitHubBot.Help.class }, description = "A friendly bot")
+public class MyGitHubBot {
+
+    interface Commands {
+
+        void run(GHEventPayload.IssueComment issueCommentPayload) throws IOException;
+    }
+
+    @Command(name = "say-hello", description = "Says hello")
+    static class SayHello implements Commands {
+
+        @Arguments
+        List<String> arguments;
+
+        @Override
+        public void run(GHEventPayload.IssueComment issueCommentPayload) throws IOException {
+            issueCommentPayload.getIssue()
+                    .comment(":wave: Hello " + (arguments != null ? String.join(" ", arguments) : "from Bot"));
+        }
+    }
+
+    @Command(name = "help", description = "Displays help")
+    static class Help extends AbstractHelpCommand implements Commands {
+    }
+}

command-airline/runtime/src/main/resources/META-INF/quarkus-extension.yaml

@@ -15,3 +15,8 @@ metadata:
   status: "stable"
   config:
     - "quarkus.github-app."
+  codestart:
+    name: "quarkiverse-github-app-command-airline"
+    languages:
+      - "java"
+    artifact: "io.quarkiverse.githubapp:quarkus-github-app-command-airline:codestarts:jar:${project.version}"

docs/modules/ROOT/pages/commands.adoc

@@ -31,6 +31,12 @@ First things first, add the `quarkus-github-app-command-airline` dependency to y
 </dependency>
 ----
 
+[NOTE]
+====
+If you requested the dependency when you generated the Quarkus project,
+Quarkus will generate a small example for you: `MyGitHubBot`.
+====
+
 == Your first command
 
 Let's say we want to implement a command to re-run a CI workflow.

docs/modules/ROOT/pages/create-github-app.adoc

@@ -14,12 +14,10 @@ WARNING: Make sure you use the `📋` button to copy the command.
 ----
 quarkus create app \
     -x quarkus-github-app \ <1>
-    org.acme:my-github-app \ <2>
-    --no-code <3>
+    org.acme:my-github-app <2>
 ----
 <1> The Quarkus GitHub App extension.
 <2> The GA of your Maven project.
-<3> Do not include unrelated generated code in the project.
 
 [TIP]
 ====
@@ -40,13 +38,11 @@ mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
     -DplatformVersion={quarkus-version} \
     -DprojectGroupId=org.acme \ <1>
     -DprojectArtifactId=my-github-app \ <2>
-    -Dextensions="io.quarkiverse.githubapp:quarkus-github-app:{quarkus-github-app-version}" \ <3>
-    -DnoCode <4>
+    -Dextensions="io.quarkiverse.githubapp:quarkus-github-app:{quarkus-github-app-version}" <3>
 ----
 <1> The groupId of your Maven project.
 <2> The artifactId of your Maven project.
 <3> The Quarkus GitHub App extension.
-<4> Do not include unrelated generated code in the project.
 
 [TIP]
 ====
@@ -118,15 +114,23 @@ Check the instructions above carefully.
 That's it! You are done with the setup and you can code your GitHub App.
 Sky is the limit.
 
-For instance, you can create the following class:
+Your newly created GitHub App comes with a small example:
 
 [source, java]
 ----
-class CreateComment {
+package org.acme;
 
-	void onOpen(@Issue.Opened GHEventPayload.Issue issuePayload) throws IOException {
-		issuePayload.getIssue().comment("Hello from my GitHub App");
-	}
+import java.io.IOException;
+
+import org.kohsuke.github.GHEventPayload;
+
+import io.quarkiverse.githubapp.event.Issue;
+
+class MyGitHubApp {
+
+    void onOpen(@Issue.Opened GHEventPayload.Issue issuePayload) throws IOException {
+        issuePayload.getIssue().comment(":wave: Hello from my GitHub App");
+    }
 }
 ----
 
@@ -143,7 +147,7 @@ In details:
 
 You are done developing your first Quarkus GitHub App.
 
-Obviously the one we developed is not very useful, but it is a good start and by using this framework:
+Obviously, the code from `MyGitHubApp` is not very useful in real life, but it is a good start and by using this framework:
 
 * You can listen to all the events currently supported by the https://github.com/hub4j/github-api[Hub4j GitHub API].
 * You have the full power of Quarkus with live coding, easy configuration, dependency injection, native executables and more.

docs/modules/ROOT/pages/includes/attributes.adoc

@@ -1,4 +1,4 @@
-:quarkus-version: 3.16.0
+:quarkus-version: 3.17.0
 :quarkus-github-app-version: 2.7.0
 
 :github-api-javadoc-root-url: https://github-api.kohsuke.org/apidocs/org/kohsuke/github

integration-tests/app/pom.xml

@@ -23,6 +23,11 @@
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-devtools-testing</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>

integration-tests/app/src/test/java/io/quarkiverse/githubapp/it/app/CodestartTest.java

@@ -0,0 +1,31 @@
+package io.quarkiverse.githubapp.it.app;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.devtools.codestarts.quarkus.QuarkusCodestartCatalog;
+import io.quarkus.devtools.codestarts.quarkus.QuarkusCodestartCatalog.Language;
+import io.quarkus.devtools.commands.CreateProject.CreateProjectKey;
+import io.quarkus.devtools.testing.codestarts.QuarkusCodestartTest;
+
+public class CodestartTest {
+    @RegisterExtension
+    public static QuarkusCodestartTest codestartTest = QuarkusCodestartTest.builder()
+            .languages(QuarkusCodestartCatalog.Language.JAVA)
+            .setupStandaloneExtensionTest("io.quarkiverse.githubapp:quarkus-github-app")
+            .putData(CreateProjectKey.PROJECT_NAME, "My GitHub App")
+            .putData(CreateProjectKey.PROJECT_DESCRIPTION, "My GitHub App description")
+            .build();
+
+    @Test
+    void testContent() throws Throwable {
+        codestartTest.checkGeneratedSource("org.acme.MyGitHubApp");
+        codestartTest.assertThatGeneratedFileMatchSnapshot(Language.JAVA, "pom.xml");
+        codestartTest.assertThatGeneratedFileMatchSnapshot(Language.JAVA, "README.md");
+    }
+
+    @Test
+    void buildAllProjects() throws Throwable {
+        codestartTest.buildAllProjects();
+    }
+}