diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5ca9720..f493bc4 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -45,7 +45,7 @@ jobs: working-directory: ./blurhasher - name: Archive built files - run: tar -czvf build.tar.gz -C ./blurhasher dist package.json package-lock.json + run: tar -czvf build.tar.gz -C ./blurhasher dist package.json - name: Upload build artifact uses: actions/upload-artifact@v4 @@ -73,8 +73,16 @@ jobs: name: built-files path: ./blurhasher + - name: Copy README.md to blurhasher + run: cp README.md blurhasher/README.md + + - name: Unpack build artifact + run: tar -xzvf build.tar.gz + working-directory: ./blurhasher + - name: Semantic Release run: npx semantic-release working-directory: ./blurhasher env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.vscode/settings.json b/.vscode/settings.json index dbec7f0..0231570 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,5 @@ { - "editor.formatOnSave": true, - "prettier.trailingComma": "es5", + "editor.formatOnSave": false, "files.eol": "\n", "eslint.validate": ["javascript", "typescript"], "editor.codeActionsOnSave": { diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fdbbe4 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Directus Blurhasher + +Это расширение для Directus, которое автоматически генерирует blurhash строки для изображений при их загрузке и сохраняет их в базе данных. + +При использовании API Directus для работы с коллекцией directus_files, в дополнение к основным полям, будет добавлено поле `blurhash`, в котором будет храниться сгенерированная blurhash строка. + +Это расширение было протестировано на версии v10.10.4 Directus, однако оно должно работать и на более ранних версиях. + +## Установка + +```bash +npm install directus-extension-blurhasher +``` + +Пример Dockerfile с установленным расширением: + +```Dockerfile +FROM directus/directus:10.10.4 + +USER root +RUN corepack enable +USER node + +RUN pnpm install directus-extension-blurhasher +``` + +## Разработка + +Для начала разработки вам необходимо запустить локальную копию Directus с помощью docker-compose. + +* Логин: `admin@example.com` +* Пароль: `admin` + +```bash +docker-compose up +``` + +После этого запустите процесс сборки в режиме разработки и следите за изменениями. + +```bash +cd blurhasher +npm install +npm run dev +``` + +Также рекомендуется использовать линтеры и форматирование кода. + +```bash +npm run lint +``` \ No newline at end of file diff --git a/blurhasher/package.json b/blurhasher/package.json index 1202ad8..b8eb9e5 100644 --- a/blurhasher/package.json +++ b/blurhasher/package.json @@ -14,15 +14,22 @@ "placeholder" ], "files": [ - "dist" + "dist", + "README.md" ], "release": { "branches": [ - "semver-ci-cd" + "main" ], "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", + [ + "@semantic-release/npm", + { + "npmPublish": true + } + ], [ "@semantic-release/github", { diff --git a/docker-compose.yml b/docker-compose.yml index 1929b39..08d8f98 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,6 +13,6 @@ services: KEY: "replace-with-random-value" SECRET: "replace-with-random-value" ADMIN_EMAIL: "admin@example.com" - ADMIN_PASSWORD: "d1r3ctu5" + ADMIN_PASSWORD: "admin" DB_CLIENT: "sqlite3" DB_FILENAME: "/directus/database/data.db"