Fix doc publishing

scalapb · Aug 3, 2020 · b8f54d4 · b8f54d4
1 parent 00e5794
commit b8f54d4
Show file tree

Hide file tree

Showing 44 changed files with 18 additions and 14 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,6 +21,9 @@ jobs:
     - uses: actions/setup-java@v1
       with:
         java-version: 12
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
     - uses: olafurpg/setup-gpg@v2
       if: startsWith(github.ref, 'refs/tags/v')
     - name: Publish ${{ github.ref }}
@@ -30,10 +33,6 @@ jobs:
         PGP_SECRET: ${{ secrets.PGP_SECRET }}
         SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
         SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
-
-    - uses: actions/setup-node@v1
-      with:
-        node-version: '12.x'
     - name: Update docs
       run: |
         git config --global user.name "ScalaPB Docs"
@@ -46,6 +45,8 @@ jobs:
         yarn deploy
       env:
           TOKEN: ${{secrets.DEPLOY_KEY}}
+          USE_SSH: true
+          GIT_USER: git
 
   scalapbc:
     runs-on: ubuntu-latest

diff --git a/build.sbt b/build.sbt
@@ -291,11 +291,11 @@ lazy val e2eNoJava = (projectMatrix in file("e2e-nojava"))
   )
 
 lazy val docs = project
-  .in(file("scalapb-docs"))
   .enablePlugins(MdocPlugin, DocusaurusPlugin, ScalaUnidocPlugin)
   .dependsOn(runtimeJVM2_12)
   .settings(commonSettings)
   .settings(
+    publish / skip := true,
     scalaVersion := Scala212,
     crossScalaVersions := Seq(Scala212),
     libraryDependencies ++= Seq(
@@ -306,7 +306,7 @@ lazy val docs = project
       "com.lihaoyi"          %% "os-lib"           % "0.5.0",
       "org.plotly-scala"     %% "plotly-render"    % "0.7.2"
     ),
-    // mdocIn := baseDirectory.value / "src" / "main" / "markdown",
+    mdocIn := baseDirectory.value / "src" / "main" / "markdown",
     siteSubdirName in ScalaUnidoc := "api/scalapb/latest",
     addMappingsToSiteDir(mappings in (ScalaUnidoc, packageDoc), siteSubdirName in ScalaUnidoc),
     unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(
@@ -318,11 +318,10 @@ lazy val docs = project
     cleanFiles += (target in (ScalaUnidoc, unidoc)).value,
     docusaurusCreateSite := docusaurusCreateSite.dependsOn(unidoc in Compile).value,
     docusaurusPublishGhpages := docusaurusPublishGhpages.dependsOn(unidoc in Compile).value,
-
     mdocVariables := Map(
-      "scalapb" -> "0.10.8",
-      "sbt_protoc" -> "0.99.34",
-      "protoc" -> "3.11.4",
+      "scalapb"          -> "0.10.8",
+      "sbt_protoc"       -> "0.99.34",
+      "protoc"           -> "3.11.4",
       "sparksql_scalapb" -> "0.10.4"
     ),
     git.remoteRepo := "[email protected]:scalapb/scalapb.github.io.git",
@@ -331,5 +330,5 @@ lazy val docs = project
     includeFilter in ghpagesCleanSite := GlobFilter(
       (ghpagesRepository.value / "README.md").getCanonicalPath
     )
-    */
+   */
   )
diff --git a/docs/common-protos.md → docs/src/main/markdown/common-protos.md b/docs/common-protos.md → docs/src/main/markdown/common-protos.md
diff --git a/docs/contact.md → docs/src/main/markdown/contact.md b/docs/contact.md → docs/src/main/markdown/contact.md
diff --git a/docs/customizations.md → docs/src/main/markdown/customizations.md b/docs/customizations.md → docs/src/main/markdown/customizations.md
diff --git a/docs/faq.md → docs/src/main/markdown/faq.md b/docs/faq.md → docs/src/main/markdown/faq.md
diff --git a/docs/generated-code.md → docs/src/main/markdown/generated-code.md b/docs/generated-code.md → docs/src/main/markdown/generated-code.md
diff --git a/docs/getting-started.md → docs/src/main/markdown/getting-started.md b/docs/getting-started.md → docs/src/main/markdown/getting-started.md
diff --git a/docs/grpc.md → docs/src/main/markdown/grpc.md b/docs/grpc.md → docs/src/main/markdown/grpc.md
diff --git a/docs/installation.md → docs/src/main/markdown/installation.md b/docs/installation.md → docs/src/main/markdown/installation.md
diff --git a/docs/intro.md → docs/src/main/markdown/intro.md b/docs/intro.md → docs/src/main/markdown/intro.md
diff --git a/docs/json.md → docs/src/main/markdown/json.md b/docs/json.md → docs/src/main/markdown/json.md
diff --git a/docs/sbt-settings.md → docs/src/main/markdown/sbt-settings.md b/docs/sbt-settings.md → docs/src/main/markdown/sbt-settings.md
diff --git a/docs/scala.js.md → docs/src/main/markdown/scala.js.md b/docs/scala.js.md → docs/src/main/markdown/scala.js.md
diff --git a/docs/scalapbc.md → docs/src/main/markdown/scalapbc.md b/docs/scalapbc.md → docs/src/main/markdown/scalapbc.md
diff --git a/docs/sealed-oneofs.md → docs/src/main/markdown/sealed-oneofs.md b/docs/sealed-oneofs.md → docs/src/main/markdown/sealed-oneofs.md
diff --git a/docs/sparksql.md → docs/src/main/markdown/sparksql.md b/docs/sparksql.md → docs/src/main/markdown/sparksql.md
diff --git a/docs/third-party-protos.md → docs/src/main/markdown/third-party-protos.md b/docs/third-party-protos.md → docs/src/main/markdown/third-party-protos.md
diff --git a/docs/upgrading.md → docs/src/main/markdown/upgrading.md b/docs/upgrading.md → docs/src/main/markdown/upgrading.md
diff --git a/docs/user_defined_options.md → ...src/main/markdown/user_defined_options.md b/docs/user_defined_options.md → ...src/main/markdown/user_defined_options.md
diff --git a/...apb-docs/src/main/protobuf/duration.proto → docs/src/main/protobuf/duration.proto b/...apb-docs/src/main/protobuf/duration.proto → docs/src/main/protobuf/duration.proto
diff --git a/scalapb-docs/src/main/protobuf/json.proto → docs/src/main/protobuf/json.proto b/scalapb-docs/src/main/protobuf/json.proto → docs/src/main/protobuf/json.proto
diff --git a/scalapb-docs/src/main/protobuf/person.proto → docs/src/main/protobuf/person.proto b/scalapb-docs/src/main/protobuf/person.proto → docs/src/main/protobuf/person.proto
diff --git a/scalapb-docs/src/main/scala/S.scala → docs/src/main/scala/S.scala b/scalapb-docs/src/main/scala/S.scala → docs/src/main/scala/S.scala
diff --git a/...la/com/thesamet/docs/json/JsonProto.scala → ...la/com/thesamet/docs/json/JsonProto.scala b/...la/com/thesamet/docs/json/JsonProto.scala → ...la/com/thesamet/docs/json/JsonProto.scala
diff --git a/.../com/thesamet/docs/json/MyContainer.scala → .../com/thesamet/docs/json/MyContainer.scala b/.../com/thesamet/docs/json/MyContainer.scala → .../com/thesamet/docs/json/MyContainer.scala
diff --git a/...la/com/thesamet/docs/json/MyMessage.scala → ...la/com/thesamet/docs/json/MyMessage.scala b/...la/com/thesamet/docs/json/MyMessage.scala → ...la/com/thesamet/docs/json/MyMessage.scala
diff --git a/...ain/scala/mytypes/duration/Duration.scala → ...ain/scala/mytypes/duration/Duration.scala b/...ain/scala/mytypes/duration/Duration.scala → ...ain/scala/mytypes/duration/Duration.scala
diff --git a/...cala/mytypes/duration/DurationProto.scala → ...cala/mytypes/duration/DurationProto.scala b/...cala/mytypes/duration/DurationProto.scala → ...cala/mytypes/duration/DurationProto.scala
diff --git a/...ain/scala/scalapb/docs/CommonProtos.scala → ...ain/scala/scalapb/docs/CommonProtos.scala b/...ain/scala/scalapb/docs/CommonProtos.scala → ...ain/scala/scalapb/docs/CommonProtos.scala
diff --git a/...cala/scalapb/docs/benchmarks/Charts.scala → ...cala/scalapb/docs/benchmarks/Charts.scala b/...cala/scalapb/docs/benchmarks/Charts.scala → ...cala/scalapb/docs/benchmarks/Charts.scala
diff --git a/...calapb/docs/benchmarks/ProtoSnippet.scala → ...calapb/docs/benchmarks/ProtoSnippet.scala b/...calapb/docs/benchmarks/ProtoSnippet.scala → ...calapb/docs/benchmarks/ProtoSnippet.scala
diff --git a/...in/scala/scalapb/docs/person/Person.scala → ...in/scala/scalapb/docs/person/Person.scala b/...in/scala/scalapb/docs/person/Person.scala → ...in/scala/scalapb/docs/person/Person.scala
diff --git a/...ala/scalapb/docs/person/PersonProto.scala → ...ala/scalapb/docs/person/PersonProto.scala b/...ala/scalapb/docs/person/PersonProto.scala → ...ala/scalapb/docs/person/PersonProto.scala
diff --git a/...ain/scala/scalapb/perf/protos/Color.scala → ...ain/scala/scalapb/perf/protos/Color.scala b/...ain/scala/scalapb/perf/protos/Color.scala → ...ain/scala/scalapb/perf/protos/Color.scala
diff --git a/...main/scala/scalapb/perf/protos/Enum.scala → ...main/scala/scalapb/perf/protos/Enum.scala b/...main/scala/scalapb/perf/protos/Enum.scala → ...main/scala/scalapb/perf/protos/Enum.scala
diff --git a/...cala/scalapb/perf/protos/EnumVector.scala → ...cala/scalapb/perf/protos/EnumVector.scala b/...cala/scalapb/perf/protos/EnumVector.scala → ...cala/scalapb/perf/protos/EnumVector.scala
diff --git a/...scala/scalapb/perf/protos/IntVector.scala → ...scala/scalapb/perf/protos/IntVector.scala b/...scala/scalapb/perf/protos/IntVector.scala → ...scala/scalapb/perf/protos/IntVector.scala
diff --git a/...calapb/perf/protos/MessageContainer.scala → ...calapb/perf/protos/MessageContainer.scala b/...calapb/perf/protos/MessageContainer.scala → ...calapb/perf/protos/MessageContainer.scala
diff --git a/...ala/scalapb/perf/protos/ProtosProto.scala → ...ala/scalapb/perf/protos/ProtosProto.scala b/...ala/scalapb/perf/protos/ProtosProto.scala → ...ala/scalapb/perf/protos/ProtosProto.scala
diff --git a/...a/scalapb/perf/protos/SimpleMessage.scala → ...a/scalapb/perf/protos/SimpleMessage.scala b/...a/scalapb/perf/protos/SimpleMessage.scala → ...a/scalapb/perf/protos/SimpleMessage.scala
diff --git a/...a/scalapb/perf/protos/StringMessage.scala → ...a/scalapb/perf/protos/StringMessage.scala b/...a/scalapb/perf/protos/StringMessage.scala → ...a/scalapb/perf/protos/StringMessage.scala
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -34,7 +34,7 @@ addSbtPlugin("com.eed3si9n" % "sbt-projectmatrix" % "0.5.2")
 
 addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % "0.4.1")
 
-addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.2.3" )
+addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.2.3")
 
 // For https://github.com/lightbend/mima/issues/422
 resolvers += Resolver.url(

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -6,7 +6,7 @@ module.exports = {
   onBrokenLinks: 'throw',
   favicon: 'img/favicon.ico',
   organizationName: 'scalapb', // Usually your GitHub org/user name.
-  projectName: 'ScalaPB', // Usually your repo name.
+  projectName: 'scalapb.github.io',
   themeConfig: {
     sidebarCollapsible: false,
     navbar: {
@@ -42,6 +42,10 @@ module.exports = {
               label: 'Installation',
               to: 'docs/installation',
             },
+            {
+              label: 'ScalaDoc',
+              href: 'https://scalapb.github.io/api/scalapb'
+            },
           ],
         },
         {
@@ -92,7 +96,7 @@ module.exports = {
           sidebarPath: require.resolve('./sidebars.js'),
           // mdoc generates to website/docs. The edit url makes it point at
           // the
-          path: '../scalapb-docs/target/mdoc',
+          path: '../docs/target/mdoc',
           // editUrl:
           //   'https://github.com/scalapb/ScalaPB/edit/master/docs/',
         },