up: update readme and add auto gen changelog on release

Author: inhere

.github/changelog.yml

@@ -0,0 +1,36 @@
+title: '## Change Log'
+# style allow: simple, markdown(mkdown), ghr(gh-release)
+style: gh-release
+# group names
+names: [Refactor, Fixed, Feature, Update, Other]
+#repo_url: https://github.com/gookit/gcli
+
+filters:
+  # message length should >= 12
+  - name: msg_len
+    min_len: 12
+  # message words should >= 3
+  - name: words_len
+    min_len: 3
+  - name: keyword
+    keyword: format code
+    exclude: true
+  - name: keywords
+    keywords: format code, action test
+    exclude: true
+
+# group match rules
+# not matched will use 'Other' group.
+rules:
+  - name: Refactor
+    start_withs: [refactor, break]
+    contains: ['refactor:']
+  - name: Fixed
+    start_withs: [fix]
+    contains: ['fix:']
+  - name: Feature
+    start_withs: [feat, new]
+    contains: [feature]
+  - name: Update
+    start_withs: [update, 'up:']
+    contains: []

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: composer
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "daily"

.github/workflows/php.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3, 7.4, 8.0] # 7.1, 7.2,
+        php: [7.3, 7.4, 8.0, 8.1] # 7.1, 7.2,
         os: [ubuntu-latest] # windows-latest, macOS-latest
         include:
           - os: 'ubuntu-latest'
@@ -29,7 +29,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # usage refer https://github.com/shivammathur/setup-php
       - name: Setup PHP

.github/workflows/release.yml

@@ -13,50 +13,31 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3]
+        php: [8.1]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set ENV for github-release
         # https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
         run: |
           echo "RELEASE_TAG=${GITHUB_REF:10}" >> $GITHUB_ENV
           echo "RELEASE_NAME=$GITHUB_WORKFLOW" >> $GITHUB_ENV
 
-      # usage refer https://github.com/shivammathur/setup-php
-      - name: Setup PHP
-        timeout-minutes: 5
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php}}
-          tools: pecl, php-cs-fixer, phpunit
-          extensions: mbstring, dom, fileinfo, mysql, openssl # , swoole-4.4.19 #optional, setup extensions
-          ini-values: post_max_size=56M, short_open_tag=On #optional, setup php.ini configuration
-          coverage: none #optional, setup coverage driver: xdebug, none
-
-      - name: Install dependencies # eg: v1.0.3
+      - name: Generate changelog
         run: |
-          tag1=${GITHUB_REF#refs/*/}
-          echo "release tag: ${tag1}"
-          composer install --no-progress --no-suggest
-
-      # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
-      # Docs: https://getcomposer.org/doc/articles/scripts.md
-
-#      - name: Build phar and send to github assets
-#        run: |
-#          echo $RELEASE_TAG
-#          echo $RELEASE_NAME
-#          php -d phar.readonly=0 bin/kite phar:pack -o kite-${RELEASE_TAG}.phar --no-progress
-#          php kite-${RELEASE_TAG}.phar -V
-
-      # https://github.com/actions/create-release
-      - uses: meeDamian/github-release@2.0
+          curl https://github.com/gookit/gitw/releases/latest/download/chlog-linux-amd64 -L -o /usr/local/bin/chlog
+          chmod a+x /usr/local/bin/chlog
+          chlog -c .github/changelog.yml -o changelog.md prev last 
+
+      # https://github.com/softprops/action-gh-release
+      - name: Create release and upload assets
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          gzip: false
-          token: ${{ secrets.GITHUB_TOKEN }}
-          tag: ${{ env.RELEASE_TAG }}
           name: ${{ env.RELEASE_TAG }}
-#          files: kite-${{ env.RELEASE_TAG }}.phar
+          tag_name: ${{ env.RELEASE_TAG }}
+          body_path: changelog.md
+          token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -657,6 +657,27 @@ $v->setSecne('update')->validate();
 
 ```
 
+## 选项设置
+
+### `StopOnError`
+
+`stopOnError` 是否在出现第一个验证错误时就停止验证。 
+
+- 默认 `true`, 总是只会拿到第一个错误,这样性能更好。
+- 设置为 `false`, 则会检查全部规则,拿到全部的验证错误。
+
+```php
+$v->setStopOnError(false);
+```
+
+### `SkipOnEmpty`
+
+- `SkipOnEmpty` 为空是否跳过验证, 默认 `true` (此时需配合 `required` 验证不可为空)
+
+```php
+$v->setSkipOnEmpty(false);
+```
+
 <a name="built-in-filters"></a>
 
 ## 内置的过滤器