onreza-release 1.0.1 → 2.1.0

package/README.md

@@ -4,17 +4,18 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![Test Coverage](https://img.shields.io/badge/coverage-99.85%25-brightgreen.svg)](https://gitverse.ru/onreza/release-tool)
 
-Инструмент автоматизации релизов с поддержкой Conventional Commits, семантического версионирования и интеграцией с GitVerse.
+Универсальный инструмент автоматизации релизов с поддержкой Conventional Commits, семантического версионирования и интеграцией с **GitVerse**, **GitHub** и **GitLab** (coming soon).
 
 ## Возможности
 
 - ✅ **Автоматическое версионирование** на основе Conventional Commits
 - 📝 **Генерация CHANGELOG** с группировкой по типам коммитов
-- 🌐 **Интеграция с GitVerse API** для создания релизов
+- 🌐 **Мультиплатформенность** — поддержка GitVerse, GitHub и GitLab
+- 🔄 **Автоопределение платформы** по git remote или CI окружению
 - 📦 **Поддержка монорепозиториев** с независимым версионированием
 - 🏷️ **Автоматические git теги и коммиты**
 - 🔍 **Режим dry-run** для безопасного тестирования
-- ⚙️ **Гибкая конфигурация** через `.gitversereleaserc.json`
+- ⚙️ **Гибкая конфигурация** через `.onrezarelease.json`
 - 🔧 **Автогенерация commitlint конфига** из release конфигурации
 - 🪝 **Хуки beforeCommit** для автоматической подготовки файлов перед релизом
 - 📤 **Бинарная дистрибуция** — публикация платформенных npm-пакетов (по паттерну esbuild/biome)
@@ -37,7 +38,12 @@ pnpm add -D onreza-release
 
 ## Быстрый старт
 
-> ⚠️ **Важно:** Для создания релизов в GitVerse необходимо настроить `GVR_TOKEN`. Без токена инструмент работает в урезанном режиме (только локальные теги и CHANGELOG). См. [Настройка GVR_TOKEN](#️-настройка-gitverse_token)
+> ⚠️ **Важно:** Для создания релизов необходимо настроить токен платформы:
+> - **GitVerse**: `GVR_TOKEN`
+> - **GitHub**: `GITHUB_TOKEN` или `GH_TOKEN`
+> - **GitLab**: `GITLAB_TOKEN` или `GL_TOKEN`
+>
+> Без токена инструмент работает в урезанном режиме (только локальные теги и CHANGELOG). См. [Настройка токенов](#️-настройка-токенов)
 
 ### 1. Базовое использование
 
@@ -51,7 +57,7 @@ npx onreza-release
 
 ### 2. Конфигурация
 
-Создайте `.gitversereleaserc.json` в корне проекта:
+Создайте `.onrezarelease.json` в корне проекта:
 
 ```json
 {
@@ -71,8 +77,9 @@ npx onreza-release
     "showHash": true,
     "showAuthor": true
   },
-  "gitverse": {
-    "createRelease": true
+  "release": {
+    "enabled": true,
+    "platform": "auto"
   }
 }
 ```
@@ -170,11 +177,12 @@ const result = await release("my-package", {
 });
 ```
 
-> **Примечание для GitVerse Actions:**
-> В GitVerse Actions автоматически доступны переменные окружения:
-> - `GVR_TOKEN` - должен быть настроен в Secrets (см. [Настройка](#️-настройка-gitverse_token))
-> - `GITVERSE_PUBLIC_API_URL` - автоматически доступен (`https://api.gitverse.ru/`)
-> - `GITHUB_REPOSITORY` - имя репозитория в формате `owner/repo`
+> **Примечание для CI:**
+> - **GitVerse Actions**: `GVR_TOKEN` должен быть настроен в Secrets
+> - **GitHub Actions**: `GITHUB_TOKEN` доступен автоматически
+> - **GitLab CI**: `GITLAB_TOKEN` должен быть настроен в Variables
+>
+> Подробнее см. [Настройка токенов](#️-настройка-токенов)
 
 ## Поддержка монорепозиториев
 
@@ -253,7 +261,7 @@ npx onreza-release generate-commitlint --format js --output .commitlintrc.js
 
 ### Конфигурация defaults
 
-Добавьте секцию `commitlint` в `.gitversereleaserc.json`:
+Добавьте секцию `commitlint` в `.onrezarelease.json`:
 
 ```json
 {
@@ -334,7 +342,7 @@ npx onreza-release publish-binaries
 
 ### Конфигурация
 
-Добавьте секцию `binaries` в `.gitversereleaserc.jsonc`:
+Добавьте секцию `binaries` в `.onrezarelease.jsonc`:
 
 ```jsonc
 {
@@ -553,6 +561,50 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```
 
+## Мультиплатформенность
+
+Инструмент поддерживает создание релизов на разных Git платформах с автоматическим определением.
+
+### Поддерживаемые платформы
+
+| Платформа | Токен | CI окружение |
+|-----------|-------|--------------|
+| **GitVerse** | `GVR_TOKEN` | GitVerse Actions |
+| **GitHub** | `GITHUB_TOKEN`, `GH_TOKEN` | GitHub Actions |
+| **GitLab** | `GITLAB_TOKEN`, `GL_TOKEN` | GitLab CI |
+
+### Автоопределение платформы
+
+Платформа определяется автоматически в следующем порядке:
+1. **CI окружение** — по переменным `GITVERSE_ACTIONS`, `GITHUB_ACTIONS`, `GITLAB_CI`
+2. **Git remote URL** — по хосту в `git remote get-url origin`
+
+### Конфигурация
+
+```json
+{
+  "release": {
+    "enabled": true,
+    "platform": "auto",       // "auto" | "gitverse" | "github" | "gitlab"
+    "checkExisting": true,    // идемпотентность
+    "failOnError": true       // прерывать при ошибке
+  }
+}
+```
+
+### Примеры использования
+
+```bash
+# Автоопределение платформы
+npx onreza-release
+
+# На GitHub
+GITHUB_TOKEN=xxx npx onreza-release
+
+# На GitLab
+GITLAB_TOKEN=xxx npx onreza-release
+```
+
 ## Конфигурация
 
 ### Полный пример
@@ -588,9 +640,11 @@ jobs:
     "allowPrerelease": false,
     "preMajorMode": "auto"
   },
-  "gitverse": {
-    "createRelease": true,
-    "token": "${GVR_TOKEN}"
+  "release": {
+    "enabled": true,
+    "platform": "auto",
+    "checkExisting": true,
+    "failOnError": true
   },
   "monorepo": {
     "enabled": false,
@@ -664,55 +718,71 @@ export GVR_TOKEN="your-token-here"
 echo "GVR_TOKEN=your-token" >> .env
 ```
 
-### ⚠️ Настройка GVR_TOKEN
+### ⚠️ Настройка токенов
 
-**КРИТИЧЕСКИ ВАЖНО:** Без настройки `GVR_TOKEN` инструмент работает в **урезанном режиме**:
+**КРИТИЧЕСКИ ВАЖНО:** Без настройки токена платформы инструмент работает в **урезанном режиме**:
 
 ✅ **С токеном (полный режим):**
-- Автоматическое создание релизов в GitVerse
+- Автоматическое создание релизов на платформе
 - Публикация changelog в релиз
 - Загрузка ассетов релиза
 - Push тегов и коммитов в удаленный репозиторий
 
 ⚠️ **Без токена (урезанный режим):**
-- ❌ НЕТ создания релизов в GitVerse
+- ❌ НЕТ создания релизов на платформе
 - ✅ Генерация CHANGELOG локально
 - ✅ Создание git тегов локально
 - ✅ Коммиты изменений локально
 
-#### Настройка токена для GitVerse Actions
+#### Токены по платформам
 
-**Важно:** `GVR_TOKEN` **НЕ предоставляется автоматически** в GitVerse Actions!
+| Платформа | Переменные окружения | Где создать |
+|-----------|---------------------|-------------|
+| **GitVerse** | `GVR_TOKEN` | Settings → Applications → Generate New Token |
+| **GitHub** | `GITHUB_TOKEN`, `GH_TOKEN` | Settings → Developer settings → Personal access tokens |
+| **GitLab** | `GITLAB_TOKEN`, `GL_TOKEN` | Preferences → Access Tokens |
 
-**Шаг 1: Создайте Personal Access Token**
-1. Перейдите в GitVerse: **Settings** → **Applications** → **Generate New Token**
-2. Выберите необходимые права:
-   - `repo` - полный доступ к репозиториям (обязательно для релизов)
-3. Скопируйте токен (показывается только один раз!)
+#### Настройка для GitVerse Actions
 
-**Шаг 2: Добавьте токен в Secrets репозитория**
-1. В репозитории: **Settings** → **Secrets and Variables** → **Actions**
-2. Нажмите **New repository secret**
-3. **Name:** `GVR_TOKEN`
-4. **Value:** ваш Personal Access Token
-5. Сохраните
+**Важно:** `GVR_TOKEN` **НЕ предоставляется автоматически** в GitVerse Actions!
 
-**Шаг 3: Используйте в workflow**
+1. Создайте Personal Access Token в GitVerse (Settings → Applications)
+2. Добавьте токен в Secrets: **Settings** → **Secrets and Variables** → **Actions** → **New repository secret**
+3. Используйте в workflow:
 ```yaml
 env:
   GVR_TOKEN: ${{ secrets.GVR_TOKEN }}
 ```
 
-**Шаг 4: Проверка (рекомендуется)**
+#### Настройка для GitHub Actions
+
+В GitHub Actions `GITHUB_TOKEN` доступен автоматически, но для создания релизов может потребоваться Personal Access Token с расширенными правами:
+
+```yaml
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  # или для расширенных прав:
+  # GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+```
+
+#### Настройка для GitLab CI
+
 ```yaml
-- name: Validate GVR_TOKEN
+variables:
+  GITLAB_TOKEN: $GITLAB_ACCESS_TOKEN  # Добавьте в Settings → CI/CD → Variables
+```
+
+#### Проверка токена (рекомендуется)
+
+```yaml
+- name: Validate Token
   run: |
-    if [ -z "$GVR_TOKEN" ]; then
-      echo "❌ ERROR: GVR_TOKEN is not set!"
-      echo "Please add GVR_TOKEN to repository secrets."
-      exit 1
-    fi
-    echo "✅ GVR_TOKEN is configured"
+    # GitVerse
+    if [ -n "$GVR_TOKEN" ]; then echo "✅ GVR_TOKEN configured"; fi
+    # GitHub
+    if [ -n "$GITHUB_TOKEN" ]; then echo "✅ GITHUB_TOKEN configured"; fi
+    # GitLab
+    if [ -n "$GITLAB_TOKEN" ]; then echo "✅ GITLAB_TOKEN configured"; fi
 ```
 
 ## CLI опции
@@ -747,7 +817,7 @@ npx onreza-release generate-binary-packages [options]
 
 Опции:
   --dry-run            Запуск без внесения изменений
-  --config <path>      Путь к конфиг файлу (default: .gitversereleaserc.json)
+  --config <path>      Путь к конфиг файлу (default: .onrezarelease.json)
   --package <name>     Имя пакета для релиза (для монорепо)
   --version <version>  Указать конкретную версию
   --prerelease [tag]   Создать prerelease версию (beta, alpha, rc)
@@ -789,7 +859,7 @@ npx onreza-release generate-binary-packages [options]
 
 ### GitVerse Actions
 
-⚠️ **Перед использованием:** Убедитесь, что `GVR_TOKEN` добавлен в Secrets репозитория (см. [Настройка GVR_TOKEN](#️-настройка-gitverse_token))
+⚠️ **Перед использованием:** Убедитесь, что `GVR_TOKEN` добавлен в Secrets репозитория (см. [Настройка токенов](#️-настройка-токенов))
 
 ```yaml
 name: Release
@@ -840,6 +910,60 @@ jobs:
 4. ✅ Создает релиз с полным функционалом (CHANGELOG, теги, GitVerse release)
 5. ✅ Автоматически публикует в GitVerse
 
+### GitHub Actions
+
+```yaml
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - run: npm ci
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Create Release
+        run: npx onreza-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### GitLab CI
+
+```yaml
+release:
+  stage: release
+  image: node:20
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      when: manual
+  before_script:
+    - git config user.name "GitLab CI"
+    - git config user.email "ci@gitlab.com"
+    - npm ci
+  script:
+    - npx onreza-release
+  variables:
+    GITLAB_TOKEN: $GITLAB_ACCESS_TOKEN
+```
+
 ## Разработка
 
 ```bash

package/dist/binaries.d.ts

@@ -1,74 +1,16 @@
 import type { BinaryCliOptions, BinaryDistributionResult } from "./types";
 /**
- * Генерирует бинарные пакеты без публикации.
- *
- * Эта функция создаёт платформенные npm-пакеты с бинарниками,
- * но не публикует их. Используйте для подготовки пакетов перед публикацией.
+ * Публикует бинарники в GitVerse Release
  *
  * Процесс:
- * 1. Загружает и валидирует конфигурацию
- * 2. Проверяет наличие бинарников для каждой платформы
- * 3. Генерирует package.json, README.md для каждого платформенного пакета
- * 4. Копирует бинарники в соответствующие директории
- * 5. Генерирует JS wrapper для основного пакета (если не skipMainPackage)
- *
- * @param options - Опции генерации
- * @param options.config - Путь к конфиг-файлу
- * @param options.version - Версия (по умолчанию из git tags)
- * @param options.platforms - Конкретные платформы для генерации
- * @param options.dryRun - Режим предпросмотра без записи файлов
- * @param options.skipMainPackage - Не генерировать JS wrapper
- * @returns Результат генерации с информацией об успешных и неудачных пакетах
- *
- * @example
- * ```typescript
- * const result = await generateBinaryPackages({
- *   dryRun: true,
- *   platforms: ["linux-x64", "darwin-arm64"],
- * });
- *
- * if (result.success) {
- *   console.log(`Generated ${result.packages.length} packages`);
- * }
- * ```
- */
-export declare function generateBinaryPackages(options?: BinaryCliOptions): Promise<BinaryDistributionResult>;
-/**
- * Генерирует и публикует бинарные пакеты в npm registry.
- *
- * Выполняет полный цикл бинарной дистрибуции:
- * 1. Загружает и валидирует конфигурацию
- * 2. Проверяет наличие бинарников для каждой платформы
- * 3. Генерирует платформенные npm-пакеты (package.json, README.md, бинарник)
- * 4. Публикует платформенные пакеты с retry при временных ошибках
- * 5. Обновляет основной package.json с optionalDependencies
- * 6. Генерирует JS wrapper для автоматического выбора бинарника
- *
- * Поведение при ошибках контролируется параметром `continueOnError` в конфиге:
- * - `false` (default): останавливается при первой ошибке
- * - `true`: продолжает, собирая ошибки в warnings
+ * 1. Загружает конфигурацию и валидирует её
+ * 2. Проверяет наличие архивов для всех платформ
+ * 3. Валидирует файлы на соответствие лимитам GitVerse
+ * 4. Создаёт или находит существующий релиз
+ * 5. Загружает архивы как assets в релиз
+ * 6. Генерирует postinstall скрипт и manifest
  *
  * @param options - Опции публикации
- * @param options.config - Путь к конфиг-файлу
- * @param options.version - Версия (по умолчанию из git tags)
- * @param options.platforms - Конкретные платформы для публикации
- * @param options.dryRun - Режим предпросмотра без записи файлов и публикации
- * @param options.generateOnly - Только генерация, без публикации
- * @param options.skipMainPackage - Не обновлять основной package.json
- * @param options.verbose - Подробный вывод
- * @returns Результат с информацией о сгенерированных и опубликованных пакетах
- *
- * @example
- * ```typescript
- * // Dry-run для проверки
- * const preview = await publishBinaries({ dryRun: true });
- *
- * // Реальная публикация
- * const result = await publishBinaries({ verbose: true });
- *
- * if (!result.success) {
- *   console.error("Errors:", result.errors);
- * }
- * ```
+ * @returns Результат публикации
  */
 export declare function publishBinaries(options?: BinaryCliOptions): Promise<BinaryDistributionResult>;