Initial commit to setup repository (#1)

* Clean and update README

* Add github config files

* Plugin repository scaffolding

Author: Jose Vitor Schneid

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Add core contributors to all prs by default
+* @smithy-lang/smithy

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+### Issue #, if available:
+
+### Description of changes:
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    name: Java ${{ matrix.java }} ${{ matrix.os }}
+    strategy:
+      matrix:
+        java: [17]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: gradle/wrapper-validation-action@v1
+
+      - name: Set up JDK ${{ matrix.java }}
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: 'corretto'
+
+      - name: clean and build
+        run: ./gradlew clean build -Plog-tests

.gitignore

@@ -0,0 +1,24 @@
+# Eclipse
+.classpath
+.project
+.settings/
+
+# Intellij
+.idea/
+*.iml
+*.iws
+
+# VSCode
+bin/
+
+# Mac
+.DS_Store
+
+# Smithy
+.smithy.lsp.log
+
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build

README.md

@@ -1,11 +1,6 @@
-## My Project
+## Smithy DocGen
 
-TODO: Fill this README out!
-
-Be sure to:
-
-* Change the title in this README
-* Edit your repository description on GitHub
+Smithy build plugin to generate API documentation from models authored in [Smithy](https://smithy.io) IDL.
 
 ## Security
 

VERSION

@@ -0,0 +1 @@
+0.1.0

build.gradle

@@ -0,0 +1,203 @@
+/*
+ * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+plugins {
+    id "java-library"
+    id "maven-publish"
+    id "signing"
+    id "checkstyle"
+    id "jacoco"
+    id "com.github.spotbugs" version "5.0.14"
+}
+
+ext {
+    // Load the plugin version from VERSION.
+    libraryVersion = project.file("VERSION").getText('UTF-8').replace(System.lineSeparator(), "")
+}
+
+println "Smithy DocGen version: '${libraryVersion}'"
+
+allprojects {
+    group = "software.amazon.smithy.docgen"
+    version = libraryVersion
+}
+
+subprojects {
+    apply plugin: "java-library"
+
+    java {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+
+    repositories {
+        mavenLocal()
+        mavenCentral()
+    }
+
+    dependencies {
+        testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.3")
+        testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.3")
+        testImplementation("org.junit.jupiter:junit-jupiter-params:5.9.3")
+        testImplementation("org.hamcrest:hamcrest:2.2")
+    }
+
+    // Reusable license copySpec for building JARs
+    def licenseSpec = copySpec {
+        from "${project.rootDir}/LICENSE"
+        from "${project.rootDir}/NOTICE"
+    }
+
+    // Set up tasks that build source and javadoc jars.
+    task sourcesJar(type: Jar) {
+        metaInf.with(licenseSpec)
+        from {
+            sourceSets.main.allJava
+        }
+        archiveClassifier = "sources"
+    }
+
+    // Build a javadoc JAR too.
+    task javadocJar(type: Jar) {
+        metaInf.with(licenseSpec)
+        from {
+            tasks.javadoc
+        }
+        archiveClassifier = "javadoc"
+    }
+
+    // Include an Automatic-Module-Name in all JARs.
+    afterEvaluate { Project project ->
+        tasks.jar {
+            metaInf.with(licenseSpec)
+            inputs.property("moduleName", project.ext["moduleName"])
+            manifest {
+                attributes "Automatic-Module-Name": project.ext["moduleName"]
+            }
+        }
+    }
+
+    // Always run javadoc after build.
+    tasks["build"].dependsOn(tasks["javadoc"])
+
+    // ==== Tests ====
+    // https://docs.gradle.org/current/samples/sample_java_multi_project_with_junit5_tests.html
+    test {
+        useJUnitPlatform()
+    }
+    // Log on passed, skipped, and failed test events if the `-Plog-tests` property is set.
+    // https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/logging/TestLoggingContainer.html
+    if (project.hasProperty("log-tests")) {
+        test {
+            testLogging {
+                events = ["passed", "skipped", "failed"]
+                exceptionFormat = "full"
+            }
+        }
+    }
+
+    // ==== Maven ====
+    apply plugin: "maven-publish"
+    apply plugin: "signing"
+
+    publishing {
+        publications {
+            mavenJava(MavenPublication) { publication ->
+                publication.from(components["java"])
+
+                // Ship the source and javadoc jars.
+                artifact(tasks["sourcesJar"])
+                artifact(tasks["javadocJar"])
+
+                // Include extra information in the POMs.
+                project.afterEvaluate {
+                    pom {
+                        name.set(project.ext["displayName"].toString())
+                        description.set(project.description)
+                        url.set("https://github.com/smithy-lang/smithy-docgen")
+                        licenses {
+                            license {
+                                name.set("Apache License 2.0")
+                                url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
+                                distribution.set("repo")
+                            }
+                        }
+                        developers {
+                            developer {
+                                id.set("smithy")
+                                name.set("Smithy")
+                                organization.set("Amazon Web Services")
+                                organizationUrl.set("https://aws.amazon.com")
+                                roles.add("developer")
+                            }
+                        }
+                        scm {
+                            url.set("https://github.com/smithy-lang/smithy-docgen.git")
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    task copyMavenMetadataForDevelopment(type: Copy) {
+        from('build/tmp/publishMavenJavaPublicationToMavenLocal') {
+            rename 'module-maven-metadata.xml', 'maven-metadata.xml'
+        }
+
+        def wdir = System.getProperty("user.home") + '/.m2/repository/software/amazon/smithy/docgen/' + project.name
+        into(wdir)
+    }
+
+    publishToMavenLocal.finalizedBy(copyMavenMetadataForDevelopment)
+
+    // ==== CheckStyle ====
+    // https://docs.gradle.org/current/userguide/checkstyle_plugin.html
+    apply plugin: "checkstyle"
+    tasks["checkstyleTest"].enabled = false
+
+    // ==== Code coverage ====
+    // https://docs.gradle.org/current/userguide/jacoco_plugin.html
+    apply plugin: "jacoco"
+    // report is always generated after tests run
+    test {
+        finalizedBy jacocoTestReport
+    }
+    // tests are required to run before generating the report
+    jacocoTestReport {
+        dependsOn test
+    }
+    jacocoTestReport {
+        reports {
+            xml.enabled false
+            csv.enabled false
+            html.destination file("$buildDir/reports/jacoco")
+        }
+    }
+
+    // ==== Spotbugs ====
+    // https://plugins.gradle.org/plugin/com.github.spotbugs
+    apply plugin: "com.github.spotbugs"
+    // We don't need to lint tests.
+    tasks["spotbugsTest"].enabled = false
+    // Configure the bug filter for spotbugs.
+    spotbugs {
+        effort = "max"
+        excludeFilter = file("${project.rootDir}/config/spotbugs/filter.xml")
+    }
+}
+
+// The root project doesn't produce a JAR.
+tasks["jar"].enabled = false