diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..9dcfa59 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,35 @@ +name: Docs + +on: + push: + branches: + - main + +jobs: + deploy_docs: + name: Deploy Docs + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Install deps + run: npm ci + env: + CI: true + + - name: Generate Docs + run: npm run docs + env: + CI: true + + - name: Set up SSH + uses: webfactory/ssh-agent@v0.5.3 + with: + ssh-private-key: ${{ secrets.SSH_KEY }} + + - name: Deploy code to server + run: | + ssh -o StrictHostKeyChecking=no ${{ secrets.SSH_USERNAME }}@${{ secrets.SSH_HOST }} 'rm -rf ${{ secrets.SSH_REMOTE_PATH }} && mkdir -p ${{ secrets.SSH_REMOTE_PATH }}' + scp -o StrictHostKeyChecking=no -r ./docs/* ${{ secrets.SSH_USERNAME }}@${{ secrets.SSH_HOST }}:${{ secrets.SSH_REMOTE_PATH }} diff --git a/README.md b/README.md index ba01dbb..3a3c845 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- + NPM version - + NPM Downloads @@ -20,14 +20,14 @@ ## Supported Databases -- [mysql](https://www.mysql.com/) (v5.6, 5.7, 8) -- [mariadb](https://mariadb.org/) (v10.3, 10.4, 10.5, 10.6, 10.7, 10.8, 10.9, 10.10, 10.11) +- [mysql](https://www.mysql.com/) (v5.6, 5.7, 8) +- [mariadb](https://mariadb.org/) (v10.3, 10.4, 10.5, 10.6, 10.7, 10.8, 10.9, 10.10, 10.11) ## Third Party Library Lupdo-mysql, under the hood, uses stable and performant npm packages: -- [mysql2](https://github.com/sidorares/node-mysql2) +- [mysql2](https://github.com/sidorares/node-mysql2) ## Usage @@ -91,12 +91,12 @@ By default Ludpo-mysql overrides user connection options with this: Lupdo-mysql has a custom type parser -- `boolean` are returned as number 1 or 0. -- `bigint` are returned as number or BigInt when necessary. -- `binary` and `blob` are returned as Buffer. -- `zerofill` numbers are returned as string. -- all `geometry` are returned as json string, coordinates are identified as x,y. -- all others types are always returned as string. +- `boolean` are returned as number 1 or 0. +- `bigint` are returned as number or BigInt when necessary. +- `binary` and `blob` are returned as Buffer. +- `zerofill` numbers are returned as string. +- all `geometry` are returned as json string, coordinates are identified as x,y. +- all others types are always returned as string. ## Parameters Binding