Глоссарий

В настоящем разделе собраны термины, определения, сокращения и аббревиатуры.

Дашборд

Дашборд (от анг. dashboard) — стартовая страница приложения, где отображается ключевая информация, такая как статистика, графики, уведомления и т.д., с возможностью настройки под собственные потребности.

Cтраница дашборда в GitVerse — это страница обзора вашего аккаунта, где вы можете видеть общую статистику, активность, задачи и т.д.

Ветка

Ветка (от анг. branch) — легковесный указатель на коммит. Создание новой ветки позволяет работать над новыми функциями или исправлениями без влияния на основную кодовую базу. Каждая ветка может иметь свою собственную историю коммитов, которую вы можете изменять независимо от других веток. Путем переключения между ветками вы можете легко управлять различными версиями вашего проекта.

Наиболее часто используемые команды:

Переключение на ветку:

git checkout <имя ветки>

или:

git switch <название_ветки>

Переключение на ветку и создание из нее новой ветки:
```
git checkout <имя ветки>
git checkout -b <имя новой ветки>
```
Просмотр локального списка веток:
```
git branch
```
Отобразится список веток, где текущая ветка будет выделена звездочкой (*):
```
$ git branch
feature-branch
* main
release-branch
```

См. Работа с ветками

Вебхук

Вебхук (от анг. webhook) — это механизм, который позволяет веб-приложениям автоматически получать информацию о событиях, происходящих в других приложениях или сервисах. Когда событие происходит в источнике данных, он отправляет HTTP POST запрос с информацией о событии на URL, который вы предварительно настроили для вебхука. Это позволяет программам взаимодействовать и реагировать на события в реальном времени.

См. Вебхуки.

Визивиг

Визивиг (от англ. WYSIWYG, What You See Is What You Get) — это термин, используемый для описания интерфейса пользователя, который позволяет видеть результаты своих действий в реальном времени. Визивиг-редакторы позволяют пользователю создавать и форматировать текст, изображения и другие элементы на веб-странице или в документе, видя при этом, как они будут выглядеть в готовом виде.

Тег (git)

Тег (tag) в системе контроля версий git — это метка, которая используется для обозначения определенного состояния репозитория. Обычно теги используются для маркировки важных моментов в истории проекта, таких как релизы или версии.

Теги в Git могут быть двух типов: легковесные (lightweight) и аннотированные (annotated).

Легковесные теги - это просто указатели на определенный коммит. Пример создания легковесного тега:

git tag -a v1.0

Аннотированные теги содержат дополнительную информацию, такую как имя автора, дата и сообщение. Пример создания аннотированного тега:

git tag -a v1.0 -m "First release"

После создания тега его можно просмотреть:

git show v1.0

Дополнительно см. раздел Теги.

Запрос (запрос на слияние)

Запрос на слияние (от анг. PR, pull request) — это запрос на включение изменений, сделанных в отдельной ветке, в основную ветку репозитория. Это процесс, при котором разработчик предлагает изменения в коде для включения в основной репозиторий. запрос позволяет другим разработчикам просмотреть и оценить предложенные изменения перед их принятием. Этот процесс помогает обеспечить качество кода и согласованность в работе над проектом.

Подробнее в Центре заботы:

Задача (рабочего процесса)

Задача в контексте CI/CD (на сленге — джоба, от анг. job) - это единица работы, которую выполняет система автоматизации. Это может быть компиляция кода, запуск тестов, развертывание приложения и т.д.

Пример конфигурационного файле рабочего процесса с двумя задачами (джобами):

name: Демонстрация GitVerse CI/CD
on:
  push:
jobs:
  job1:
    name: Test context
    runs-on: ubuntu-latest
    steps:
      - name: Display event name
        run: echo ${{ gitverse.event_name }}
      - name: Display Workflow
        run: echo ${{ gitverse.workflow }}
  job2:
    name: Display repository details
    runs-on: ubuntu-latest
    steps:
      - name: Display repository name
        run: echo ${{ gitverse.Repository}}
      - name: Display repository owner
        run: echo ${{ gitverse.repository_owner }}
      - name: Display actor
        run: echo ${{ gitverse.actor }}

Запускающее событие (рабочего процесса)

См. Триггер (рабочего процесса).

Коммит

Коммит (от анг. commit) — это процесс сохранения изменений в коде в репозиторий. Коммит позволяет зафиксировать текущее состояние проекта и сделанные изменения. После выполнения команды "git commit", все изменения, добавленные в индекс (staging area) с помощью команды "git add", будут сохранены в репозитории.

Коммиты содержат информацию о том, какие изменения были сделаны и от кого. Изменения можно комментировать. Коммит является ключевым элементом процесса разработки, позволяющим отслеживать историю изменений в проекте и обеспечивать его целостность и согласованность‍.

Пример добавления, коммита и передачи (пуша) в удаленный репозиторий:

git add .
git commit -m "место для комментария к коммиту"
git push

Дополнительно см.:

Термин хеш коммита.
Термин SHA.
Раздел Коммит.

Куки

Куки (от анг. cookie) в контексте web разработки — это небольшой набор данных, передаваемых одной программой другой. Они могут использоваться для идентификации в компьютерных приложениях, например, при посещении веб-сайта серверное приложение может оставить на компьютере посетителя HTTP-куки для аутентификации клиента при его возвращении на сайт. Куки также могут быть использованы для хранения желаемых настроек пользователя и его предпочтений. Однако, стоит отметить, что существуют сторонние куки, которые сохраняются другими сайтами и могут использоваться для отслеживания онлайн-активности пользователя.‍

Лейбл раннера (CI/CD)

См. Метка раннера (CI/CD).

Метка раннера (CI/CD)

Метка раннера в YAML рабочего процесса - это метка, которую вы можете использовать для указания, на каком раннере должен выполняться ваш рабочий процесс.

Пример присвоения метки раннеру (--labels self-hosted — строка 6) при его неинтерактивной регистрации:

sudo ./act_runner_linux_amd64 register \
--no-interactive \
--instance https://gitverse.ru/sc \
--token DtYdkGFpO408x0qnUqgTuMwB7IVtoZ5WANL95GQr \
--name workspace-example \
--labels self-hosted

Пример указания метки раннера в yaml-файле рабочего процесса:

...
jobs:
  update:
    runs-on: self-hosted # метка раннера (label), задается при регистрации
...

Примеры взяты из раздела Workspace локального раннера, пример.

Лоадер (анимированный значок загрузки)

Лоадер (от анг. loader) — графический элемент для создания визуальной обратной связи, информирующий пользователя о прогрессе выполнения задачи.

Пуш коммита

Пуш коммита (от анг. push commit) — это процесс отправки изменений, сделанных в локальной копии репозитория, на удаленный сервер. Это делает вашу работу доступной для других пользователей и сохраняет историю изменений в общем репозитории.

Пример добавления коммита и передачи (пуша) в удаленный репозиторий:

git add .
git commit -m "место для комментария к коммиту"
git push

Рабочий процесс (CI/CD)

Рабочий процесс (от анг. workflow) в контексте CI/CD — это методология разработки программного обеспечения, которая автоматизирует процесс интеграции, развертывания, сборки, тестирование и др.

Файлы рабочего процесса — это .yaml-файлы, которые определяют конфигурацию и последовательность задач, которые должны быть выполнены в рамках GitVerse Actions. Файлы написаны на языке разметки YAML и содержат информацию о том, какие действия и события должны произойти, а также какие условия должны быть выполнены для запуска задач.

Файлы рабочего процесса позволяют автоматизировать различные процессы в разработке программного обеспечения, такие как развертывание и другие операции.

YAML файлы рабочего процесса должны храниться в репозитории в папке .gitverse/workflows/, но раннеры GitVerse также обработают и yaml-файлы в директории .github/workflows.

Cм. CI/CD.

Раннер (CI/CD)

Раннер (от анг. runner) — это приложение, которое выполняет задачи в рамках рабочего процесса GitVerse Acrtions (CI/CD).

Файл YAML в .gitverse/workflows/ в вашем репозитории определяет задачи и конфигурацию рабочего процесса, а раннер выполняет эти задачи в соответствии с указанными параметрами.

На данный момент доступен раннер в виде бинарного файла или докер образа, см.:

Раннеры.
CI/CD.

Триггер (рабочего процесса CI/CD)

Триггер рабочего процесса CI/CD — это событие, вызывающие запуск раннера и выполнение им рабочего процесса.

См. СI/CD:

Тултип

Тултип (от анг. tooltip) — это небольшое всплывающее окно с информацией, которое появляется при наведении курсора на определенный элемент интерфейса. Тултип обычно содержит краткое описание или подсказку, объясняющую назначение или использование этого элемента.

Пример тултипа, призванного отобразить слишком длинное имя ветки:

Форк

Форк (от анг. fork) в контексте Git — это процесс создания отдельной ветки (ответвления) от основной ветки репозитория. Он позволяет разработчику вносить изменения в код, не затрагивая основную ветку, и затем предложить эти изменения для включения в основной репозиторий через запрос. Форк может быть использован для реализации экспериментальных изменений, портирования на новые платформы или спасения проекта, если основной проект заморожен или не развивается. Форк может продолжать сосуществовать с основным проектом и обмениваться с ним содержимым, или же приобрести абсолютно другие свойства и перестать иметь что-то общее с базовым проектом‍.

Подробнее в Центре заботы:

⚠️

После удаления форка репозитория восстановить его невозможно. Если вы удалили приватный репозиторий, все его форки будут удалены.

Хеш коммита

Хеш коммита — общепринятое название для уникального идентификатора коммита с использованием SHA.

См. SHA, Secure Hash Algorithm.

SHA

SHA (от англ. Secure Hash Algorithm) — алгоритм, который используется для создания уникального идентификатора коммита (хеша коммита).

username

В контексте настроек аккаунта username — это ваш логин в GitVerse.

Cм. Смена username.

Workflow

Workflow:

В контексте CI/CD — см. Рабочий процесс (CI/CD).

База знаний Карта GitVerse