Generate README (#7)

* git config.

* update cli using github-push-action.

* exclude pull request events.

* fmt.

* remove extra section on index.md

* fix.

.github/workflows/ci.yml

@@ -52,17 +52,24 @@ jobs:
   docs:
     runs-on: ubuntu-20.04
     timeout-minutes: 30
+    if: github.event_name != 'pull_request'
     steps:
       - uses: actions/[email protected]
         with:
+          ref: ${{ github.head_ref }}
           fetch-depth: 0
       - name: generate readme
         run: sbt docs/generateReadme
       - name: commit and push readme changes
         run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
           git add README.md
           git commit -m "update readme."
-          git push origin
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          branch: ${{ github.head_ref }}
 
   publish:
     runs-on: ubuntu-20.04

build.sbt

@@ -66,9 +66,7 @@ lazy val zioSbtWebsite =
         scriptedLaunchOpts.value ++
           Seq("-Xmx1024M", "-Dplugin.version=" + version.value)
       },
-      scriptedBufferLog                          := false,
-      libraryDependencies += "com.typesafe.play" %% "twirl-api" % "1.6.0-M7",
-        libraryDependencies += "com.typesafe.play" %% "twirl-compiler" % "1.6.0-M7"
+      scriptedBufferLog := false
     )
     .enablePlugins(SbtPlugin, ZioEcosystemProjectPlugin)
 

docs/index.md

@@ -34,20 +34,6 @@ ZIO SBT Website is an SBT plugin that has the following tasks:
 - `sbt publishToNpm`— publishes documentation inside the `docs` directory to the npm registry.
 - `sbt generateGithubWorkflow`— generates GitHub workflow which publishes documentation for each library release.
 
-## Contributing
-
-For the general guidelines, see ZIO [contributor's guide](https://github.com/zio/zio/blob/master/docs/about/contributing.md).
-
-#### TL;DR
-
-Before you submit a PR, make sure your tests are passing, and that the code is properly formatted
-
-```
-sbt prepare
-
-sbt testPlugin
-```
-
 
 [Badge-CI]: https://github.com/zio/zio-sbt/workflows/CI/badge.svg
 [Badge-SonatypeReleases]: https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.12.svg "Sonatype Releases"

zio-sbt-website/src/main/scala/zio/sbt/WebsitePlugin.scala

@@ -16,13 +16,14 @@
 
 package zio.sbt
 
+import java.nio.file.{Files, Path, Paths}
+
+import scala.sys.process.*
+
 import mdoc.MdocPlugin
 import mdoc.MdocPlugin.autoImport.*
-import sbt.*
 import sbt.Keys.*
-
-import java.nio.file.{Files, Path, Paths}
-import scala.sys.process.*
+import sbt.*
 
 object WebsitePlugin extends sbt.AutoPlugin {