Add header on .github/workflows/build.yml (#8)

* Header on .github/workflows/build.yml Tells unaware user that the "build.yml" is not needed. * Update the header on build workflow --------- Co-authored-by: Orhun Parmaksız <[email protected]>
ratatui · Jul 13, 2023 · 120ffa5 · 120ffa5
1 parent 3cdb6b0
commit 120ffa5
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,9 +1,17 @@
-name: 'Build Template'
+# Test the builds for the template
+#
+# When you got this file through:
+#   cargo generate --git https://github.com/tui-rs-revival/rust-tui-template --name <project-name>
+# you can deleted it safely. (Above directories also.)
+#
+# By the way: Enjoy the template :-)
+
+name: "Build Template"
 on:
   workflow_dispatch:
   schedule:
     # Run once a week at 6pm on Saturday (UTC)
-    - cron: '0 18 * * 6'
+    - cron: "0 18 * * 6"
   push:
     paths-ignore:
       - "**.md"
@@ -28,4 +36,3 @@ jobs:
           mv $PROJECT_NAME ${{ runner.temp }}/
           cd ${{ runner.temp }}/$PROJECT_NAME
           cargo check
-