Atlantis Raijin

Что это

Raijin — это подход к работе в едином инженерном контуре, поставляемый как кастомный Yarn-бандл atls Он объединяет команды вокруг строгих стандартов и мощных контрактов, чтобы повышать предсказуемость поставки и реальную производительность

Для кого

• Для команд, которые поддерживают несколько Node.js/TypeScript проектов
• Для разработчиков, которым нужен единый контракт команд в локальной среде и в GitHub Actions
• Для опенсорс и внутренних репозиториев, где важны предсказуемые проверки и обновления

Что умеет Raijin

• Проверки кода: check, lint, typecheck, test, checks *
• Работа с изменениями: files changed *, workspaces changed *
• Сборка и выпуск: service build, library build, release create, npm publish
• Генераторы и служебные команды для инфраструктуры монорепозитория

Быстрый старт

Новый проект

mkdir -p .yarn/releases && \
curl -fsSL https://raw.githubusercontent.com/atls/raijin/master/.yarn/releases/yarn.mjs -o .yarn/releases/yarn.mjs && \
yarn config set yarnPath .yarn/releases/yarn.mjs && \
yarn set version atls && \
rm .yarn/releases/yarn.mjs

Ожидаемый результат:

• В проекте появляется временный файл первичного подключения .yarn/releases/yarn.mjs
• yarn set version atls обновляет бандл через файл релиза GitHub и переключает yarnPath на версионный файл .yarn/releases/raijin-yarn-<version>.mjs
• Временный файл .yarn/releases/yarn.mjs удаляется после переключения
• Команды raijin становятся доступны через yarn

Обновление

yarn set version atls

Ожидаемый результат:

• Бандл обновляется до последней доступной версии штатным механизмом Yarn

Проверка

yarn check
yarn files changed list

Ожидаемый результат:

• Команды выполняются без ошибки маршрутизации и с ожидаемым набором шагов

Как использовать в чужом проекте

1. Подключите бандл по разделу Быстрый старт
2. Зафиксируйте изменения .yarn/releases и .yarnrc.yml в системе контроля версий
3. Обновляйте бандл командой yarn set version atls по мере выхода новых версий

Где читать дальше

• RU (по умолчанию): README.md
• EN: README_EN.md
• Индекс документации RU: docs/README.ru.md
• Индекс документации EN: docs/README.md
• Роутер раздела Raijin: docs/raijin/README.ru.md
• Быстрый старт: docs/raijin/quickstart.ru.md
• Карта команд: docs/raijin/commands.ru.md
• Карта пакетов: docs/raijin/packages.ru.md