Как начать работать с SourceCraft

Примечание

Сервис находится на стадии Preview. Для сервиса не действует соглашение об уровне обслуживания SLA, и его использование не тарифицируется.

SourceCraft — платформа, с помощью которой вы можете разрабатывать исходный код, управлять версиями, тестировать, собирать, развертывать и сопровождать программные продукты. Сервис представляет собой систему управления репозиториями кода для git с отслеживанием ошибок и пайплайном CI/CD.

Условия использования сервиса SourceCraft

Чтобы начать работу с сервисом:

Зарегистрируйтесь

Если у вас еще нет Яндекс ID, зарегистрируйтесь.

Если для входа на Яндекс вы используете профиль в социальной сети, заведите логин и пароль.
На главной странице SourceCraft нажмите Войти и выберите профиль Яндекс ID, с которым вы хотите зарегистрироваться в сервисе.
Выберите организацию, которая будет использоваться для работы с сервисом.

Если у вас уже зарегистрирована организация в Yandex Cloud, вы можете использовать в SourceCraft ее же.

Если у вас нет организации в Yandex Cloud, автоматически будет создана организация для работы с SourceCraft.

Также вы можете создать новую организацию.

Совет

Для авторизации корпоративных аккаунтов в SourceCraft с помощью системы единого входа (Single Sign-On, SSO) вы можете использовать SAML-совместимые федерации удостоверений Yandex Cloud.
Нажмите Продолжить .
На открывшейся странице заполните информацию профиля:
- Имя (обязательное поле);
- Страна;
- Город;
- Компания;
- Имя;
- О себе;
- Ссылки.
Также вы можете добавить изображение для профиля и фон.
Нажмите Выглядит отлично, открыть дашборд.

Создайте репозиторий

На панели слева нажмите Создать репозиторий.
В блоке Сведения о новом репозитории:
- Выберите Пустой репозиторий — будет создан новый репозиторий.
  
  Также вы можете импортировать существующий репозиторий в SourceCraft.
- В поле Название укажите название репозитория, например test-repo. Название репозитория может содержать следующие ASCII-символы: строчные и заглавные буквы латинского алфавита, цифры, запятые, дефисы и подчеркивания.
- (опционально) В поле Описание укажите описание репозитория.
В блоке Шаблон репозитория нажмите Просмотр шаблонов, выберите подходящий шаблон репозитория и нажмите Использовать шаблон.

Шаблоны содержат предустановленную конфигурацию CI/CD, а также типовые файлы проекта.

Чтобы посмотреть содержимое шаблона, нажмите Предварительный просмотр.
В блоке Видимость выберите тип доступа к репозиторию — Приватный. Доступ к репозиторию будут иметь только пользователи, приглашенные вами.
Нажмите Создать репозиторий.

Проверьте тестовый CI/CD-процесс

При инициализации репозитория будет выполнен тестовый CI/CD-процесс.

Проверьте выполнение CI/CD-процесса:

На странице репозитория в разделе Код перейдите в секцию Автоматизации.
Выберите запущенный рабочий процесс (workflow).
На открывшейся странице будут отображены все задания (tasks) рабочего процесса, шаги задания — кубики (cubes), а также статусы и результаты выполнения.

Подготовьте окружение

Установите Git.
Создайте пару из открытого и закрытого SSH-ключей для учетной записи в SourceCraft:
Linux/macOS

Windows 10/11

Windows 7/8
1. Откройте терминал.
2. Создайте новый ключ с помощью команды ssh-keygen:
  ssh-keygen -t ed25519 -C "<опциональный_комментарий>"
  Вы можете передать в параметре -C пустую строку, чтобы не добавлять комментарий, или не указывать параметр -C вообще — в таком случае будет добавлен комментарий по умолчанию.
  
  После выполнения команды вам будет предложено указать имя и путь к файлам с ключами, а также ввести пароль для закрытого ключа. Если задать только имя, пара ключей будет создана в текущей директории. Открытый ключ будет сохранен в файле с расширением .pub, закрытый ключ — в файле без расширения.
  
  По умолчанию команда предлагает сохранить ключ под именем id_ed25519 в директории /home/<имя_пользователя>/.ssh. Если в этой директории уже есть SSH-ключ с именем id_ed25519, вы можете случайно перезаписать его и потерять доступ к ресурсам, в которых он используется. Поэтому рекомендуется использовать уникальные имена для всех SSH-ключей.
Если у вас еще не установлен OpenSSH, установите его по инструкции.
1. Запустите cmd.exe или powershell.exe (предварительно обновите PowerShell).
2. Создайте новый ключ с помощью команды ssh-keygen:
  ssh-keygen -t ed25519 -C "<опциональный_комментарий>"
  Вы можете передать в параметре -C пустую строку, чтобы не добавлять комментарий, или не указывать параметр -C вообще — в таком случае будет добавлен комментарий по умолчанию.
  
  После выполнения команды вам будет предложено указать имя и путь к файлам с ключами, а также ввести пароль для закрытого ключа. Если задать только имя, пара ключей будет создана в текущей директории. Открытый ключ будет сохранен в файле с расширением .pub, закрытый ключ — в файле без расширения.
  
  По умолчанию команда предлагает сохранить ключ под именем id_ed25519 в папку C:\Users\<имя_пользователя>/.ssh. Если в этой директории уже есть SSH-ключ с именем id_ed25519, вы можете случайно перезаписать его и потерять доступ к ресурсам, в которых он используется. Поэтому рекомендуется использовать уникальные имена для всех SSH-ключей.
Создайте ключи с помощью приложения PuTTY:
1. Скачайте и установите PuTTY.
2. Добавьте папку с PuTTY в переменную PATH:
  1. Нажмите кнопку Пуск и в строке поиска Windows введите Изменение системных переменных среды.
  2. Справа снизу нажмите кнопку Переменные среды....
  3. В открывшемся окне найдите параметр PATH и нажмите Изменить.
  4. Добавьте путь к папке в список.
  5. Нажмите кнопку ОК.
3. Запустите приложение PuTTYgen.
4. В качестве типа генерируемой пары выберите EdDSA. Нажмите Generate и поводите курсором в поле выше до тех пор, пока не закончится создание ключа.
5. В поле Key passphrase введите надежный пароль. Повторно введите его в поле ниже.
6. Нажмите кнопку Save private key и сохраните закрытый ключ. Никому не сообщайте ключевую фразу от него.
7. Нажмите кнопку Save public key и сохраните открытый ключ в файле <имя_ключа>.pub.
Запустите SSH-агент:
Linux/MacOS

Windows
1. Выполните команду:
  ssh-agent -s
2. Чтобы SSH-агент запускался при входе в систему, в файл ~/.profile добавьте команду запуска:
  ssh-agent -s
1. Откройте контекстное меню кнопки Пуск.
2. Выберите пункт Управление компьютером.
3. Перейдите в раздел Службы и приложения → Службы.
4. Откройте контекстное меню службы SSH agent и выберите пункт Свойства.
5. На вкладке Главное измените тип запуска с Выключена на Автоматически.
6. Нажмите кнопку OK и запустите службу.

Добавьте ключ в агент SSH:

ssh-add <путь_к_закрытому_ключу>

Также вы можете получить доступ к репозиторию с помощью персонального токена (PAT).

Добавьте SSH-ключ в SourceCraft

Откройте главную страницу сервиса.
На панели слева нажмите Домой и перейдите в раздел Доступ → SSH-ключи.
На странице SSH-ключи нажмите Новый SSH ключ:
- В поле Название ключа укажите произвольное название ключа.
- В поле Значение вставьте содержимое файла с открытым SSH-ключом.
Нажмите Создать ключ.

Клонируйте репозиторий

На странице репозитория в правом верхнем углу нажмите кнопку Клонировать.
Скопируйте ссылку для клонирования репозитория из поля SSH.

В терминале выполните команду:

git clone <ссылка_для_клонирования_репозитория>

Перейдите в склонированный репозиторий:
```
cd <имя_репозитория>
```

Внесите изменения в новую ветку

Создайте новую ветку для изменений и отправьте в удаленный репозиторий:
```
git checkout -b new-feature
git push -u origin new-feature
```
Внесите изменения в файлы репозитория. Например, отредактируйте файл README.md.
Внесите измененный файл в индекс git, сделайте коммит и отправьте изменения в удаленный репозиторий:
```
git add .
git commit -m "updated README.md"
git push origin new-feature
```

Предложите изменения

На странице репозитория в SourceCraft в разделе Код перейдите в секцию Предложения изменений.
В правом верхнем углу нажмите Предложить изменения.
В выпадающем списке источник выберите ветку new-feature, в цель — main.
(опционально) Укажите название и описание предложения изменений.
Нажмите Опубликовать предложение изменений.

Выполните слияние с основной веткой

Чтобы посмотреть, что предлагается изменить, перейдите на вкладку Изменённые файлы.
Одобрите изменения — в правом верхнем углу нажмите Одобрить.
Нажмите Принять предложение изменений.