update

.github/workflows/assayo.yml

@@ -1,6 +1,20 @@
+# Creates an HTML report
+# with analysis of commit statistics.
+# 
+# More information: https://github.com/bakhirev/assayo
 name: Assayo
+description: Report with analysis of commit statistics
 
 on:
+  # Run by time
+  # (if you have a lot of people and frequent commits)
+  # Remove this for small teams:
+  schedule:
+  - cron: '3 * * * *'
+
+  # Run by PR
+  # (if you have few people and commits are rarely made)
+  # Remove this for big teams:
   pull_request:
     types: [closed]
   push:
@@ -23,7 +37,6 @@ jobs:
 
     - name: Create report
       run: |
-        git fetch --unshallow || true
         git clone https://github.com/bakhirev/assayo.git
         git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > ./assayo/build/log.txt
 

README.md

@@ -205,8 +205,8 @@ Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v
 JIRA-1234 feat(profile): Added avatar for user 
 ```
 - task number in the task tracker `(JIRA-1234)`
-- type of work `(feat, fix, style, refactor, test, doc и т.д.)`
-- feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`
+- type of work `(feat, fix, style, refactor, test, doc and etc.)`
+- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
 - what problem were solved `(Added avatar for user)`
   <a name="link-22"></a>
 ### 👮 How to add checking for commit message?

documents/EN.md

@@ -195,8 +195,8 @@ Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v
 JIRA-1234 feat(profile): Added avatar for user 
 ```
 - task number in the task tracker `(JIRA-1234)`
-- type of work `(feat, fix, style, refactor, test, doc и т.д.)`
-- feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`
+- type of work `(feat, fix, style, refactor, test, doc and etc.)`
+- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
 - what problem were solved `(Added avatar for user)`
 <a name="link-22"></a>
 ### 👮 How to add checking for commit message?

documents/src/json/en.json

@@ -295,8 +295,8 @@
     {
         "li": [
             "task number in the task tracker `(JIRA-1234)`",
-            "type of work `(feat, fix, style, refactor, test, doc и т.д.)`",
-            "feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`",
+            "type of work `(feat, fix, style, refactor, test, doc and etc.)`",
+            "feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`",
             "what problem were solved `(Added avatar for user)`"
         ]
     },

documents/src/md/EN.md

@@ -97,8 +97,8 @@ Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v
 JIRA-1234 feat(profile): Added avatar for user 
 ```
 - task number in the task tracker `(JIRA-1234)`
-- type of work `(feat, fix, style, refactor, test, doc и т.д.)`
-- feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`
+- type of work `(feat, fix, style, refactor, test, doc and etc.)`
+- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
 - what problem were solved `(Added avatar for user)`
 
 <a name="link-13"></a>

public/themes/demo.html

@@ -138,7 +138,7 @@
     }
 
     const mode = parameters.mode || 'white';
-    const url = `http://localhost:3006/?dump=./test.txt&theme=./themes/${mode}.css`;
+    const url = `https://bakhirev.github.io/demo/?dump=./test.txt&theme=./themes/${mode}.css`;
     getElementById('frame').setAttribute('src', url);
   }