Merge pull request #30 from crowdsecurity/fix-release-process

fix release process

Author: mobula9

docs/api/ApiCache.md

@@ -14,8 +14,9 @@ The cache mecanism to store every decisions from LAPI/CAPI. Symfony Cache compon
 |[clear](#apicacheclear)||
 |[configure](#apicacheconfigure)|Configure this instance.|
 |[get](#apicacheget)|Request the cache for the specified IP.|
-|[prune](#apicacheprune)||
+|[prune](#apicacheprune)|Prune the cache (only when using PHP File System cache).|
 |[pullUpdates](#apicachepullupdates)|Used in stream mode only.|
+|[testConnection](#apicachetestconnection)|Test the connection to the cache system (Redis or Memcached).|
 |[warmUp](#apicachewarmup)|Used in stream mode only.|
 
 
@@ -124,10 +125,10 @@ Request the cache for the specified IP.
 **Description**
 
 ```php
- prune (void)
+public prune (void)
 ```
 
- 
+Prune the cache (only when using PHP File System cache). 
 
 
 
@@ -170,6 +171,36 @@ Used for the stream mode when we have to update the remediations list.
 <hr />
 
 
+### ApiCache::testConnection  
+
+**Description**
+
+```php
+public testConnection (void)
+```
+
+Test the connection to the cache system (Redis or Memcached). 
+
+ 
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+**Throws Exceptions**
+
+
+`\BouncerException`
+> if the connection was not successful
+
+<hr />
+
+
 ### ApiCache::warmUp  
 
 **Description**

docs/api/Bouncer.md

@@ -21,6 +21,7 @@ The main Class of this package. This is the first entry point of any PHP Bouncer
 |[getRemediationForIp](#bouncergetremediationforip)|Get the remediation for the specified IP. This method use the cache layer.|
 |[pruneCache](#bouncerprunecache)|This method prune the cache: it removes all the expired cache items.|
 |[refreshBlocklistCache](#bouncerrefreshblocklistcache)|Used in stream mode only.|
+|[testConnection](#bouncertestconnection)|Test the connection to the cache system (Redis or Memcached).|
 |[warmBlocklistCacheUp](#bouncerwarmblocklistcacheup)|Used in stream mode only.|
 
 
@@ -295,6 +296,36 @@ This method should be called periodically (ex: crontab) in a asynchronous way to
 <hr />
 
 
+### Bouncer::testConnection  
+
+**Description**
+
+```php
+public testConnection (void)
+```
+
+Test the connection to the cache system (Redis or Memcached). 
+
+ 
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+**Throws Exceptions**
+
+
+`\BouncerException`
+> if the connection was not successful
+
+<hr />
+
+
 ### Bouncer::warmBlocklistCacheUp  
 
 **Description**

docs/api/RestClient.md

@@ -90,7 +90,7 @@ Send an HTTP request using the file_get_contents and parse its JSON result if an
 
 
 `\BouncerException`
-> when the reponse status is not 2xx.
+> when the reponse status is not 2xx
 
 <hr />
 

scripts/publish-release.sh

@@ -18,22 +18,17 @@ elif [[ "$unamestr" == 'Darwin' ]]; then
 fi
 git_base_dir=`git rev-parse --show-toplevel`
 
-# Update version everywhere (add and commit changes)
+# Update version everywhere (add and commit changes), tag and release
+git checkout main
 if [[ $platform == 'linux' ]]; then
-   sed -i -E "s/v[0-9]+\.[0-9]+\.[0-9]/$NEW_GIT_VERSION/" `git rev-parse --show-toplevel`/src/Constants.php
+   sed -i -E "s/v[0-9]+\.[0-9]+\.[0-9]/$NEW_GIT_VERSION/" $git_base_dir/src/Constants.php
 else
-   sed -i "" -E "s/v[0-9]+\.[0-9]+\.[0-9]/$NEW_GIT_VERSION/" `git rev-parse --show-toplevel`/src/Constants.php
+   sed -i "" -E "s/v[0-9]+\.[0-9]+\.[0-9]/$NEW_GIT_VERSION/" $git_base_dir/src/Constants.php
 fi
-git add `git rev-parse --show-toplevel`/src/Constants.php
-
-
 git add $git_base_dir/src/Constants.php
-git commit -m "bump version to $NEW_GIT_VERSION"
-git push
-echo "Note: new commit \"bump version to $NEW_GIT_VERSION\""
 
-# Tag and release
-git checkout main
 git tag $NEW_GIT_VERSION
+git commit -m "bump version to $NEW_GIT_VERSION"
+git push
 git push origin $NEW_GIT_VERSION
 gh release create --draft $NEW_GIT_VERSION --title $NEW_GIT_VERSION

src/Bouncer.php

@@ -198,8 +198,8 @@ public function checkCaptcha(string $expected, string $try, string $ip)
     }
 
     /**
-     * Test the connection to the cache system (Redis or Memcached)
-     * 
+     * Test the connection to the cache system (Redis or Memcached).
+     *
      * @throws BouncerException if the connection was not successful
      * */
     public function testConnection()