Auto-generate README File (#354)

* auto-generate readme file.

* installation section.

.github/workflows/site.yml

@@ -1,28 +1,73 @@
-# This file was autogenerated using `zio-sbt` via `sbt generateGithubWorkflow` 
-# task and should be included in the git repository. Please do not edit 
-# it manually. 
+# This file was autogenerated using `zio-sbt-website` via `sbt generateGithubWorkflow` 
+# task and should be included in the git repository. Please do not edit it manually.
 
-name: website
-
-on:
+name: Website
+'on':
+  workflow_dispatch: {}
   release:
-    types: [ published ]
-
+    types:
+    - published
+  push:
+    branches:
+    - develop
 jobs:
   publish-docs:
-    runs-on: ubuntu-20.04
-    timeout-minutes: 30
+    name: Publish Docs
+    runs-on: ubuntu-latest
+    if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }}
+    steps:
+    - name: Git Checkout
+      uses: actions/checkout@v3.1.0
+      with:
+        fetch-depth: '0'
+    - name: Setup Scala
+      uses: actions/setup-java@v3.6.0
+      with:
+        distribution: temurin
+        java-version: 17
+        check-latest: true
+    - name: Setup NodeJs
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16.x
+        registry-url: https://registry.npmjs.org
+    - name: Publish Docs to NPM Registry
+      run: sbt  docs/publishToNpm
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  generate-readme:
+    name: Generate README
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.1.0
-        with:
-          fetch-depth: 0
-      - name: Setup Scala and Java
-        uses: olafurpg/setup-scala@v13
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Publishing Docs to NPM Registry
-        run: sbt docs/publishToNpm
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    - name: Git Checkout
+      uses: actions/checkout@v3.1.0
+      with:
+        ref: ${{ github.head_ref }}
+        fetch-depth: '0'
+    - name: Setup Scala
+      uses: actions/setup-java@v3.6.0
+      with:
+        distribution: temurin
+        java-version: 17
+        check-latest: true
+    - name: Generate Readme
+      run: sbt  docs/generateReadme
+    - name: Commit 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.md" || echo "No changes to commit"
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v4
+      with:
+        title: Update README.md
+        commit-message: Update README.md
+        branch: zio-sbt-website/update-readme
+        body: |
+          Autogenerated changes after running the `sbt docs/generateReadme` command of the [zio-sbt-website](https://zio.dev/zio-sbt) plugin.
+
+          I will automatically update the README.md file whenever there is new change for README.md, e.g.
+            - After each release, I will update the version in the installation section.
+            - After any changes to the "docs/index.md" file, I will update the README.md file accordingly.
+

docs.sbt

@@ -1,11 +1,27 @@
-
 lazy val docs = project
   .in(file("izumi-docs"))
   .settings(
     publish / skip := true,
     moduleName := "izumi-docs",
     scalacOptions -= "-Yno-imports",
-    scalacOptions -= "-Xfatal-warnings"
+    scalacOptions -= "-Xfatal-warnings",
+    projectName := "Izumi Reflect",
+    badgeInfo := Some(
+      BadgeInfo(
+        artifact = "izumi-reflect_2.12",
+        projectStage = ProjectStage.ProductionReady
+      )
+    ),
+    docsPublishBranch := "develop",
+    readmeCredits :=
+      """|`izumi-reflect` has been created by [Septimal Mind](https://7mind.io) to power [Izumi Project](https://github.com/7mind/izumi),
+         |as a replacement for `TypeTag` in reaction to a lack of confirmed information about the future of `scala-reflect`/`TypeTag` in Scala 3 ([Motivation](https://blog.7mind.io/lightweight-reflection.html)), and donated to ZIO.
+         |
+         |<p align="center">
+         |  <a href="https://izumi.7mind.io/">
+         |  <img width="40%" src="https://github.com/7mind/izumi/blob/develop/doc/microsite/src/main/tut/media/izumi-logo-full-purple.png?raw=true" alt="Izumi"/>
+         |  </a>
+         |</p>
+         |""".stripMargin
   )
   .enablePlugins(WebsitePlugin)
-

docs/index.md

@@ -4,16 +4,21 @@ title: "Introduction to izumi-reflect"
 sidebar_label: "izmumi-reflect"
 ---
 
+---
+
+<p align="center">
+  <a href="https://www.buymeacoffee.com/7mind"><img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Izumi"/></a>
+</p>
 
-# izumi-reflect
+---
 
 > @quote: Looks a bit similar to TypeTag
 
-`izumi-reflect` is a fast, lightweight, portable and efficient alternative for `TypeTag` from `scala-reflect`.
+`izumi-reflect` is a fast, lightweight, portable and efficient alternative for `TypeTag` from `scala-reflect`. `izumi-reflect` is a lightweight model of Scala type system and provides a simulator of the important parts of the Scala typechecker.
 
-`izumi-reflect` is a lightweight model of Scala type system and provides a simulator of the important parts of the Scala typechecker.
+@PROJECT_BADGES@
 
-## Why `izumi-reflect`
+## Why `izumi-reflect`?
 
 1. `izumi-reflect` compiles faster, runs a lot faster than `scala-reflect` and is fully immutable and [thread-safe](https://github.com/scala/bug/issues/10766),
 2. `izumi-reflect` supports Scala 2.11, 2.12, 2.13 and **Scala 3**,
@@ -31,9 +36,17 @@ Known limitations are:
 2. Existential types, both written with wildcards and `forSome` may produce unexpected results, the support is limited,
 3. Path-Dependent Types are based on variable names and may cause unexpected results when variables with different names have the same type or vice-versa (vs. Scala compiler)
 4. This-Types such as `X.this.type` are ignored and identical to `X`
-5. At the moment Scala 3 port does not support Path-Dependent Types, and Structural Refinements. This will be fixed in the future.
+5. At the moment Scala 3 port does not support Structural Refinements. This will be fixed in the future.
 6. `izumi-reflect` is less powerful than `scala-reflect`: it does not preserve fields and methods when it's not necessary for equality and subtype checks, it does not preserve code trees, internal compiler data structures, etc.
 
+## Installation
+
+In order to use this library, we need to add the following line in our `build.sbt` file:
+
+```scala
+libraryDependencies += "dev.zio" %% "izumi-reflect" % "@VERSION@"
+```
+
 ## Debugging
 
 Set [`-Dizumi.reflect.debug.macro.rtti=true`](https://javadoc.io/doc/dev.zio/izumi-reflect_2.13/latest/izumi/reflect/DebugProperties$.html#izumi.reflect.debug.macro.rtti:String(%22izumi.reflect.debug.macro.rtti%22)) to enable debug output during compilation when tags are constructed and at runtime when they are compared.

docs/sidebars.js

@@ -1,6 +1,12 @@
 const sidebars = {
   sidebar: [
-    "index"
+    {
+      type: "category",
+      label: "Izumi Reflect",
+      collapsed: false,
+      link: { type: "doc", id: "index" },
+      items: [ ]
+    }
   ]
 };
 

project/docs-plugins.sbt

@@ -1,3 +1,3 @@
-addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.0.0+83-40726325-SNAPSHOT")
+addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.2.0")
 
 resolvers += Resolver.sonatypeRepo("public")