Add docu sync for releases

2025-09-27 04:46:08 +08:00 · 2023-07-09 18:23:58 +02:00 · 2023-07-09 18:11:23 +02:00 · 2023-07-09 14:47:35 +02:00 · 2023-07-09 14:47:12 +02:00 · 2023-07-08 22:00:47 +02:00
26 changed files with 349 additions and 98 deletions
--- a/.github/logo-dark.svg
+++ b/.github/logo-dark.svg
--- a/.github/logo.svg
+++ b/.github/logo.svg
--- a/.github/scripts/sync_docs.sh
+++ b/.github/scripts/sync_docs.sh
@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+
+# Some env variables
+BRANCH="main"
+REPO_URL="github.com/gofiber/docs.git"
+AUTHOR_EMAIL="github-actions[bot]@users.noreply.github.com"
+AUTHOR_USERNAME="github-actions[bot]"
+VERSION_FILE="storage_versions.json"
+REPO_DIR="storage"
+COMMIT_URL="https://github.com/gofiber/storage"
+DOCUSAURUS_COMMAND="npm run docusaurus -- docs:version:storage"
+
+# Set commit author
+git config --global user.email "${AUTHOR_EMAIL}"
+git config --global user.name "${AUTHOR_USERNAME}"
+
+git clone https://${TOKEN}@${REPO_URL} fiber-docs
+
+# Handle push event
+if [ "$EVENT" == "push" ]; then
+latest_commit=$(git rev-parse --short HEAD)
+
+for f in $(find . -type f -name "*.md" -not -path "./fiber-docs/*"); do
+  log_output=$(git log --oneline "${BRANCH}" HEAD~1..HEAD --name-status -- "${f}")
+
+    if [[ $log_output != "" || ! -f "fiber-docs/docs/${REPO_DIR}/$f" ]]; then
+      mkdir -p fiber-docs/docs/${REPO_DIR}/$(dirname $f)
+      cp "${f}" fiber-docs/docs/${REPO_DIR}/$f
+  fi
+done
+
+# Handle release event
+elif [ "$EVENT" == "release" ]; then
+  # Extract package name from tag
+  package_name="${TAG_NAME%/*}"
+  major_version="${TAG_NAME#*/}"
+  major_version="${major_version%%.*}"
+
+  # Form new version name
+  new_version="${package_name}_${major_version}.x.x"
+
+  cd fiber-docs/ || true
+  npm ci
+
+  # Check if contrib_versions.json exists and modify it if required
+  if [[ -f $VERSION_FILE ]]; then
+    jq --arg new_version "$new_version" 'del(.[] | select(. == $new_version))' $VERSION_FILE > temp.json && mv temp.json $VERSION_FILE
+    jq -S . ${VERSION_FILE} > temp.json && mv temp.json ${VERSION_FILE}
+  fi
+
+  # Run docusaurus versioning command
+  $DOCUSAURUS_COMMAND "${new_version}"
+fi
+
+# Push changes
+cd fiber-docs/ || true
+git add .
+if [[ $EVENT == "push" ]]; then
+    git commit -m "Add docs from ${COMMIT_URL}/commit/${latest_commit}"
+elif [[ $EVENT == "release" ]]; then
+    git commit -m "Sync docs for release ${COMMIT_URL}/releases/tag/${TAG_NAME}"
+fi
+
+MAX_RETRIES=5
+DELAY=5
+retry=0
+
+while ((retry < MAX_RETRIES))
+do
+    git push https://${TOKEN}@${REPO_URL} && break
+    retry=$((retry + 1))
+    git pull --rebase
+    sleep $DELAY
+done
+
+if ((retry == MAX_RETRIES))
+then
+    echo "Failed to push after $MAX_RETRIES attempts. Exiting with 1."
+    exit 1
+fi
--- a/.github/workflows/security.yml
+++ b/.github/workflows/security.yml
--- a/.github/workflows/sync-docs.yml
+++ b/.github/workflows/sync-docs.yml
@@ -0,0 +1,38 @@
+name: 'Sync docs'
+
+on:
+    push:
+        branches:
+            - master
+            - main
+        paths:
+            - '**/*.md'
+    release:
+        types: [published]
+        branches:
+            - '*/v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+    sync-docs:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  ref: ${{ github.event.pull_request.head.sha }}
+                  fetch-depth: 2
+
+            - name: Setup Node.js environment
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18'
+
+            - name: Install JQ
+              run: sudo apt-get install jq
+
+            - name: Sync docs
+              run: ./.github/scripts/sync_docs.sh
+              env:
+                  EVENT: ${{ github.event_name }}
+                  TAG_NAME: ${{ github.ref_name }}
+                  TOKEN: ${{ secrets.DOC_SYNC_TOKEN }}
--- a/.github/workflows/test-memory.yml
+++ b/.github/workflows/test-memory.yml
--- a/MIGRATE.md
+++ b/MIGRATE.md
@@ -1,22 +0,0 @@
-This document contains instructions for migrating to various storage versions.
-
-### 0.1 -> 0.2
-v0.2 fixes [a bug](https://github.com/gofiber/fiber/issues/1258) in MYSQL, Postgres and Arangodb in which 
-inserting non-UTF8 characters would trigger a panic due to the values being saved in a TEXT column instead of a 
-BYTEA/BLOB column. Migration instructions (note you may need to adjust the table names if you have supplied a custom
-config to the storage):
-
-**Postgres**
-```sql
-ALTER TABLE fiber_storage
-ALTER COLUMN v TYPE BYTEA USING v::bytea;
-```
-
-**MYSQL**
-```sql
-ALTER TABLE fiber_storage MODIFY COLUMN v BLOB;
-```
-
-**Arangodb**
-
-No migration other then updating the library is necessary.
--- a/README.md
+++ b/README.md
@@ -1,20 +1,24 @@
+---
+title: 👋 Welcome
+description: 📦 Premade storage drivers for 🚀 Fiber.
+sidebar_position: 1
+---
+
 <p align="center">
-  <picture>
-    <source height="125" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gofiber/docs/master/static/img/logo-dark.svg">
-    <img height="125" alt="Fiber" src="https://raw.githubusercontent.com/gofiber/docs/master/static/img/logo.svg">
-  </picture>
-  <br>
+  <img height="125" alt="Fiber" src="https://raw.githubusercontent.com/gofiber/storage/master/.github/logo-dark.svg#gh-dark-mode-only" />
+  <img height="125" alt="Fiber" src="https://raw.githubusercontent.com/gofiber/storage/master/.github/logo.svg#gh-light-mode-only" />
+  <br/>

 # 📦 Storage

  <a href="https://pkg.go.dev/github.com/gofiber/storage?tab=doc">
-    <img src="https://img.shields.io/badge/%F0%9F%93%9A%20godoc-pkg-00ACD7.svg?color=00ACD7&style=flat">
+    <img src="https://img.shields.io/badge/%F0%9F%93%9A%20godoc-pkg-00ACD7.svg?color=00ACD7&style=flat"/>
  </a>
  <a href="https://goreportcard.com/report/github.com/gofiber/storage">
-    <img src="https://img.shields.io/badge/%F0%9F%93%9D%20goreport-A%2B-75C46B">
+    <img src="https://img.shields.io/badge/%F0%9F%93%9D%20goreport-A%2B-75C46B"/>
  </a>
  <a href="https://gofiber.io/discord">
-    <img src="https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7">
+    <img src="https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7"/>
  </a>
 </p>

@@ -48,54 +52,21 @@ type Storage interface {

 ## 📑 Storage Implementations

- [ArangoDB](/arangodb) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+ArangoDB%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-arangodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [AzureBlob](/azureblob) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Azure+Blob%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-azureblob.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Badger](/badger) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Badger%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-badger.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Bbolt](/bbolt) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Bbolt%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-bbolt.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Couchbase](/couchbase) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Couchbase%22">
-    <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-couchbase.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [DynamoDB](/dynamodb) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+DynamoDB%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-dynamodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Etcd](/etcd) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Etcd%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-Etcd.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Memcache](/memcache) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Memcache%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-memcache.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Memory](/memory) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Local+Storage%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [MongoDB](/mongodb) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Mongodb%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mongodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [MSSQL](/mssql) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+MSSQL%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mssql.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [MySQL](/mysql) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+MySQL%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mysql.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Pebble](/pebble) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Pebble%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-pebble.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Postgres](/postgres) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Postgres%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-postgres.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [Redis](/redis) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Redis%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-redis.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [SQLite3](/sqlite3) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Sqlite3%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-sqlite3.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
-  </a>
- [S3](/s3) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+S3%22">
-  <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-s3.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
+- [ArangoDB](./arangodb/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+ArangoDB%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-arangodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [AzureBlob](./azureblob/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Azure+Blob%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-azureblob.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Badger](./badger/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Badger%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-badger.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Bbolt](./bbolt) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Bbolt%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-bbolt.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Couchbase](./couchbase/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Couchbase%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-couchbase.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [DynamoDB](./dynamodb/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+DynamoDB%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-dynamodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Etcd](./etcd/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Etcd%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-etcd.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Memcache](./memcache/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Memcache%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-memcache.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Memory](./memory/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Local+Storage%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-memory.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [MongoDB](./mongodb/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Mongodb%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mongodb.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [MSSQL](./mssql/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+MSSQL%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mssql.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [MySQL](./mysql/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+MySQL%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mysql.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Pebble](./pebble/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Pebble%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-pebble.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Postgres](./postgres/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Postgres%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-postgres.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [Redis](./redis/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Redis%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-redis.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [S3](./s3/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+S3%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-s3.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>
+- [SQLite3](./sqlite3/README.md) <a href="https://github.com/gofiber/storage/actions?query=workflow%3A%22Tests+Sqlite3%22"> <img src="https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-sqlite3.yml?branch=main&label=%F0%9F%A7%AA%20&style=flat&color=75C46B" /> </a>

--- a/arangodb/README.md
+++ b/arangodb/README.md
@@ -1,4 +1,14 @@
-# ArangoDB
+---
+id: arangodb
+title: ArangoDB
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=arangodb*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-arangodb.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)
+
 A ArangoDB storage driver using `arangodb/go-driver` and [arangodb/go-driver](https://github.com/arangodb/go-driver).

 ### Table of Contents
--- a/azureblob/README.md
+++ b/azureblob/README.md
@@ -1,4 +1,13 @@
-# Azure blob
+---
+id: azureblob
+title: Azure Blob
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=azureblob*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-azureblob.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 [Azure Blob storage](https://azure.microsoft.com/en-us/products/storage/blobs/#overview) is Microsoft's object storage solution for the cloud.

--- a/badger/README.md
+++ b/badger/README.md
@@ -1,4 +1,13 @@
-# Badger
+---
+id: badger
+title: Badger
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=badger*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-badger.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A fast key-value DB using [dgraph-io/badger](https://github.com/dgraph-io/badger)

--- a/bbolt/README.md
+++ b/bbolt/README.md
@@ -1,4 +1,14 @@
-# Bbolt
+---
+id: bbolt
+title: Bbolt
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=bbolt*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-bbolt.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)
+
 A Bbolt storage driver using [etcd-io/bbolt](https://github.com/etcd-io/bbolt). Bolt is a pure Go key/value store inspired by [Howard Chu's](https://twitter.com/hyc_symas) [LMDB project](https://www.symas.com/symas-embedded-database-lmdb). The goal of the project is to provide a simple, fast, and reliable database for projects that don't require a full database server such as Postgres or MySQL.


--- a/couchbase/README.md
+++ b/couchbase/README.md
@@ -1,4 +1,13 @@
-# Couchbase
+---
+id: couchbase
+title: Couchbase
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=couchbase*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-couchbase.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A Couchbase storage driver using [couchbase/gocb](https://github.com/couchbase/gocb).

--- a/dynamodb/README.md
+++ b/dynamodb/README.md
@@ -1,4 +1,14 @@
-# DynamoDB
+---
+id: dynamodb
+title: DynamoDB
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=dynamodb*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-dynamodb.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)
+
 A DynamoDB storage driver using [aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2).

 **Note:** If config fields of credentials not given, credentials are using from the environment variables, ~/.aws/credentials, or EC2 instance role. If config fields of credentials given, credentials are using from config. Look at: [specifying credentials](https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials)
--- a/etcd/README.md
+++ b/etcd/README.md
@@ -1,4 +1,13 @@
-# Etcd
+---
+id: etcd
+title: Etcd
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=etcd*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-etcd.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A Etcd storage driver using [`etcd-io/etcd`](https://github.com/etcd-io/etcd).

--- a/memcache/README.md
+++ b/memcache/README.md
@@ -1,4 +1,13 @@
-# Memcache
+---
+id: memcache
+title: Memcache
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=memcache*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-memcache.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A Memcache storage driver using [`bradfitz/gomemcache`](https://github.com/bradfitz/gomemcache).

--- a/memory/README.md
+++ b/memory/README.md
@@ -1,4 +1,14 @@
-# Memory
+---
+id: memory
+title: Memory
+---
+
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=memory*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-memory.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 An in-memory storage driver.

--- a/mongodb/README.md
+++ b/mongodb/README.md
@@ -1,4 +1,13 @@
-# MongoDB
+---
+id: mongodb
+title: MongoDB
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=mongodb*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mongodb.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A MongoDB storage driver using [mongodb/mongo-go-driver](https://github.com/mongodb/mongo-go-driver).

--- a/mssql/README.md
+++ b/mssql/README.md
@@ -1,4 +1,13 @@
-# MSSQL
+---
+id: mssql
+title: MSSQL
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=mssql*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mssql.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A MSSQL storage driver using [microsoft/go-mssqldb](https://github.com/microsoft/go-mssqldb).

--- a/mysql/README.md
+++ b/mysql/README.md
@@ -1,4 +1,13 @@
-# MySQL
+---
+id: mysql
+title: MySQL
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=mysql*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-mysql.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A MySQL storage driver using `database/sql` and [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql).

--- a/pebble/README.md
+++ b/pebble/README.md
@@ -1,4 +1,13 @@
-# Pebble
+---
+id: pebble
+title: Pebble
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=pebble*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-pebble.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A fast key-value DB using [cockroachdb/pebble](https://github.com/cockroachdb/pebble)

--- a/postgres/README.md
+++ b/postgres/README.md
@@ -1,4 +1,13 @@
-# Postgres
+---
+id: postgres
+title: Postgres
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=postgres*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-postgres.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A Postgres storage driver using [jackc/pgx](https://github.com/jackc/pgx).

--- a/redis/README.md
+++ b/redis/README.md
@@ -1,4 +1,13 @@
-# Redis
+---
+id: redis
+title: Redis
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=redis*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-redis.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A Redis storage driver using [go-redis/redis](https://github.com/go-redis/redis).

--- a/ristretto/README.md
+++ b/ristretto/README.md
@@ -1,4 +1,13 @@
-# Ristretto
+---
+id: ristretto
+title: Ristretto
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=ristretto*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-ristretto.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A Memory-bound storage driver using [`dgraph-io/ristretto`](https://github.com/dgraph-io/ristretto).

--- a/s3/README.md
+++ b/s3/README.md
@@ -1,4 +1,13 @@
-# S3
+---
+id: s3
+title: S3
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=s3*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-s3.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A S3 storage driver using [aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2).

--- a/sqlite3/README.md
+++ b/sqlite3/README.md
@@ -1,4 +1,13 @@
-# SQLite3
+---
+id: sqlite3
+title: SQLite3
+---
+
+![Release](https://img.shields.io/github/v/tag/gofiber/storage?filter=sqlite3*)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://img.shields.io/github/actions/workflow/status/gofiber/storage/test-sqlite3.yml?label=Tests)
+![Security](https://img.shields.io/github/actions/workflow/status/gofiber/storage/gosec.yml?label=Security)
+![Linter](https://img.shields.io/github/actions/workflow/status/gofiber/storage/linter.yml?label=Linter)

 A SQLite3 storage driver using [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3).
Author	SHA1	Message	Date
René Werner	98bebea186	Add docu sync for releases	2023-07-09 18:23:58 +02:00
René Werner	56a4cbfc19	Add docu sync for releases	2023-07-09 18:11:23 +02:00
René Werner	60220b5b83	Add docu sync for releases	2023-07-09 14:47:35 +02:00
René Werner	304146395d	Add docu sync for releases	2023-07-09 14:47:12 +02:00
RW	a5635a782f	Update README.md fix dark and light mode picture https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/	2023-07-08 22:00:47 +02:00
René Werner	df66fb784c	remove empty security workflow	2023-07-08 21:08:06 +02:00
RW	9a9a1ce716	Update README.md	2023-07-08 21:03:57 +02:00
RW	5c3a1ca3eb	Merge pull request #883 from gofiber/Memory-shield Memory shield	2023-07-08 13:28:26 +02:00
RW	95226eed34	Merge pull request #882 from gofiber/Memory-shield-1 Rename test.yml to test-memory.yml	2023-07-08 13:26:35 +02:00
RW	33a61daca9	Rename test.yml to test-memory.yml	2023-07-08 13:25:52 +02:00
RW	6c71397839	Update README.md	2023-07-08 13:24:32 +02:00
RW	9fba60d754	Merge pull request #881 from gofiber/update-readme update	2023-07-07 17:42:22 +02:00
Muhammed Efe Cetin	a115ee2fba	update	2023-07-07 18:40:33 +03:00
RW	31e2d80802	Update README.md	2023-07-07 17:15:47 +02:00
RW	bbbd3e8ad1	Update README.md	2023-07-07 17:06:10 +02:00
RW	9edc233ee7	Update README.md	2023-07-07 16:58:25 +02:00
M. Efe Çetin	c030fac063	📝 docs: automated synchronization with `gofiber/docs` (#880 ) * add sync_docs script * update docs * update docs * Update README.md - sort lines and fix closing image tag * update docs --------- Co-authored-by: RW <rene@gofiber.io>	2023-07-07 17:45:22 +03:00
RW	36401996a5	Merge pull request #879 from erkanzsy/main README.md updated for Etcd label	2023-07-05 14:11:56 +02:00
Erkan Ozsoy	c4a57d2fbe	README.md updated for Etcd label	2023-07-05 10:48:18 +03:00