Справочная документация

Необходимые условия для запуска GitVerse Pages

Имя пользователя и организации

Требования к репозиторию

1. Доступность

• Репозиторий должен быть публичным. Приватные репозитории в текущей версии GitVerse Pages не поддерживаются.

2. Наличие файлов

• Репозиторий не должен быть пустым. Для сборки необходимы index.md или index.html или README.md или структура Jekyll.
  Если в корне есть index.md и index.html, index.md игнорируется.

3. Активированный CI/CD

• Pages запускает публикацию через GitVerse CI/CD, поэтому в репозитории должен быть включен раздел “CI/CD”.

Названия файлов: правила и ограничения

Нельзя:

• начинать имя с подчеркивания, если это не _layouts, _includes, _posts, _data;
• использовать пробелы: мой пост.md;
• использовать кириллицу: новости.md;
• добавлять спецсимволы: photo@home.jpg;
• ставить точки в середине или двойные точки: config.local.json, file..txt;
• называть файлы в конфликте со служебными каталогами: posts.md, site.html;
• использовать неподдерживаемые расширения: .py, .zip, .exe.

Ограничения и лимиты

Лимиты GitVerse Pages

• время на сборку Страниц идет из общего лимита на сборочное время CI/CD;
• артефакты Страниц расходуют лимит на сборочные артефакты;
• итоговый артефакт сборки ≤ 500 МБ;
• в корне ветки должны присутствовать один из файлов:
  • index.md;
  • index.html;
  • README.md.

Справочная информация

Преобразование имен репозиториев

Точки в репозиториях автоматически заменяются на дефисы: my.project → my-project.

Поддерживаемый генератор статики

• **Jekyll 3.9.*;
• сборка выполняется автоматически с использованием нашего builder-а.

Где размещается сайт

Сайты доступны по адресу:

https://<username>.gitverse.site/<repo-name>/

Логи сборки

Логи сборки и публикации GitVerse Pages доступны здесь:

• в интерфейсе Репозиторий -> Настройки -> Страницы отображается ссылка «Открыть запуск сборки»;
• на вкладке CI/CD в workflow c названием build-and-deploy-pages.

Срок хранения артефактов

По умолчанию — 1 день. Затем артефакты автоматически удаляются.

Работа со ссылками и структурой

Формат относительных ссылок

Пример:

Чувствительность к регистру

About.md и about.md — разные файлы.