Update Checkout Action Version (#27)

* update checkout action. * update checkout action version.
zio · Dec 25, 2022 · 77ad5c5 · 77ad5c5
1 parent 4b5b037
commit 77ad5c5
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 12 deletions.
diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml
@@ -17,7 +17,7 @@ jobs:
     if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }}
     steps:
     - name: Git Checkout
-      uses: actions/checkout@v3.1.0
+      uses: actions/checkout@v3.2.0
       with:
         fetch-depth: '0'
     - name: Setup Scala
@@ -40,7 +40,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Git Checkout
-      uses: actions/checkout@v3.1.0
+      uses: actions/checkout@v3.2.0
       with:
         ref: ${{ github.head_ref }}
         fetch-depth: '0'
@@ -64,10 +64,9 @@ jobs:
         title: Update README.md
         commit-message: Update README.md
         branch: zio-sbt-website/update-readme
-        body: |
+        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.
-
diff --git a/docs/index.md b/docs/index.md
@@ -26,8 +26,8 @@ enablePlugins(WebsitePlugin)
 ZIO SBT Website is an SBT plugin that has the following tasks:
 
 - `sbt compileDocs`— compile documentation inside `docs` directory. The compilation result will be inside `website/docs` directory.
-- `sbt installWebsite`— creates a website for the project inside the `website` directory
+- `sbt installWebsite`— creates a website for the project inside the `website` directory.
 - `sbt previewWebsite`— runs a local webserver that serves documentation locally on http://localhost:3000. By changing the documentation inside the `docs` directory, the website will be reloaded with new content.
 - `sbt publishToNpm`— publishes documentation inside the `docs` directory to the npm registry.
 - `sbt generateGithubWorkflow`— generates GitHub workflow which publishes documentation for each library release.
-- `sbt generateReadme`— generate README.md file.
+- `sbt generateReadme`— generate README.md file from `docs/index.md` and sbt setting keys.
diff --git a/zio-sbt-website/src/main/scala/zio/sbt/WebsitePlugin.scala b/zio-sbt-website/src/main/scala/zio/sbt/WebsitePlugin.scala
@@ -299,12 +299,13 @@ object WebsitePlugin extends sbt.AutoPlugin {
 
   lazy val generateGithubWorkflowTask: Def.Initialize[Task[Unit]] =
     Def.task {
+      val workflow = WebsiteUtils.websiteWorkflow(docsPublishBranch.value, sbtBuildOptions.value, docsVersioning.value)
+
       val template =
         s"""|# 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.
             |
-            |${WebsiteUtils.websiteWorkflow(docsPublishBranch.value, sbtBuildOptions.value, docsVersioning.value)}
-            |""".stripMargin
+            |$workflow""".stripMargin
 
       IO.write(new File(".github/workflows/site.yml"), template)
     }

diff --git a/zio-sbt-website/src/main/scala/zio/sbt/WebsiteUtils.scala b/zio-sbt-website/src/main/scala/zio/sbt/WebsiteUtils.scala
@@ -188,7 +188,7 @@ object WebsiteUtils {
                   Seq(
                     Step.SingleStep(
                       name = "Git Checkout",
-                      uses = Some(ActionRef("actions/checkout@v3.1.0")),
+                      uses = Some(ActionRef("actions/checkout@v3.2.0")),
                       parameters = Map("fetch-depth" -> "0".asJson)
                     ),
                     Step.SingleStep(
@@ -225,7 +225,7 @@ object WebsiteUtils {
               steps = Seq(
                 Step.SingleStep(
                   name = "Git Checkout",
-                  uses = Some(ActionRef("actions/checkout@v3.1.0")),
+                  uses = Some(ActionRef("actions/checkout@v3.2.0")),
                   parameters = Map(
                     "ref"         -> "${{ github.head_ref }}".asJson,
                     "fetch-depth" -> "0".asJson
@@ -264,8 +264,7 @@ object WebsiteUtils {
                          |
                          |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.
-                         |""".stripMargin.asJson
+                         |  - After any changes to the "docs/index.md" file, I will update the README.md file accordingly.""".stripMargin.asJson
                   )
                 )
               )