Что такое snippets git

Сопоставляем неоднозначные термины в GitLab, GitHub и Bitbucket

Всем привет, если вы не в курсе, мы начали публиковать переводы релизных статей ГитЛаба.
Если вы пропустили предыдущие, вот ссылки: 8.10, 8.9, 8.8

ГитЛаб выпускает релизы 22 числа каждого месяца.
Перевод поста про релиз 8.11 в работе, а пока представляю на ваш суд еще одну статью из блога ГитЛаба про различие терминологии у GitLab, GitHub и Bitbucket.

В зависимости от рабочих задач и потребностей клиентов разработчикам приходится использовать разные платформы управления репозиториями. Типичный разработчик участвует в каком-нибудь открытом проекте на GitHub, а на работе хостит проект одного клиента на GitLab, а другого — в Mercurial и на Bitbucket. Переключения между платформами осложняются тем, что в них одни и те же вещи могут называться совершенно по-разному. В этой статье мы поможем вам сопоставить различия и заодно объясним, почему мы выбрали именно такие названия.

Начиная с версии 8.4 в GitLab значительно улучшился процесс миграции репозиториев из GitHub. Теперь GitLab импортирует не только репозитории, но ещё и вики-страницы, тикеты и пулл-реквесты. При этом большинство сущностей не меняют своего названия. Например, специфические термины Git, такие как commit или push, везде одинаковы. Не меняются и такие общие термины, как users, webhooks и issues.

Если вы только начинаете работать с GitLab, эта таблица поможет вам быстрее освоиться:

Команды, Репозитории и Организации

Давайте разберёмся, чем отличаются команда (team), репозиторий (repository) и организация (organization). В GitHub репозитории содержат собственно репозиторий Git или SVN, а также тикеты (issues), статистику участия и т.п. При этом, пользователи нередко называют репозитории проектами.

В GitLab мы устранили неоднозначность, явно называя такую структуру проектом (project). Проект включает в себя репозиторий Git, тикеты, мерж-реквесты и всё остальное. На странице конфигурации проекта можно:

Важно понимать, что даже если вы импортируете в GitLab только чистый репозиторий Git или нечто, что в источнике называется «репозиторием», в результате вы всегда получите проект GitLab.

Важное отличие: в Bitbucket проектом (project) называется объединение нескольких репозиториев. Такие проекты в свою очередь принадлежат командам (teams). В GitHub аналогичную задачу выполняют организации (organizations).

В GitLab такие структуры, объединяющие несколько проектов, называются группами (groups). Пользователи, входящие в группу, получают доступ на чтение, изменение и настройку проектов в зависимости от своей роли в группе. Каждый проект принадлежит только одной группе, но его можно «расшарить» для других групп. Эта фича есть в Gitlab Enterprise Edition, а также в GitLab Community Edition начиная с версии 8.5. Если вы хотите явным образом запретить расшаривание проектов, это можно сделать в настройках группы.

Надеюсь, что эта статья помогла вам лучше разобраться в терминологии. Если у вас ещё остались вопросы, задавайте их в комментариях.

Источник

GitLab

Snippets (FREE)

With GitLab snippets, you can store and share bits of code and text with other users. You can comment on, clone, and use version control in snippets. They can contain multiple files. They also support syntax highlighting, embedding, downloading, and you can maintain your snippets with the snippets API.

GitLab provides two types of snippets:

Create snippets

You can create snippets in multiple ways, depending on whether you want to create a personal or project snippet:

After you create a snippet, you can still add more files to it. In GitLab versions 13.0 and later, snippets are versioned by default.

Discover snippets

To discover all snippets visible to you in GitLab, you can:

Change default visibility of snippets

Project snippets are enabled and available by default. To change their default visibility:

Versioned snippets

In GitLab versions 13.0 and later, snippets (both personal and project snippets) have version control enabled by default.

This means that all snippets get their own underlying repository initialized with a default branch at the moment the snippet is created. Whenever a change to the snippet is saved, a new commit to the default branch is recorded. Commit messages are automatically generated. The snippet’s repository has only one branch. You can’t delete this branch, or create other branches.

Existing snippets were automatically migrated in 13.0. Their current content was saved as the initial commit to the snippets’ repository.

Filenames

Snippets support syntax highlighting based on the filename and extension provided for them. While you can submit a snippet without a filename and extension, it needs a valid name so the content can be created as a file in the snippet’s repository.

When upgrading from an earlier version of GitLab to 13.0, existing snippets without a supported filename are renamed to a compatible format. For example, if the snippet’s filename is http://a-weird-filename.me it is changed to http-a-weird-filename-me to be included in the snippet’s repository. As snippets are stored by ID, changing their filenames breaks direct or embedded links to the snippet.

Add or remove multiple files

A single snippet can support up to 10 files, which helps keep related files together, such as:

If you need more than 10 files for your snippet, we recommend you create a wiki instead. Wikis are available for projects at all subscription levels, and groups for GitLab Premium.

Snippets with multiple files display a file count in the snippet list:

You can manage snippets with Git (because they’re versioned by a Git repository), through the Snippets API, and in the GitLab UI.

To add a new file to your snippet through the GitLab UI:

To delete a file from your snippet through the GitLab UI:

Clone snippets

Instead of copying a snippet to a local file, you may want to clone a snippet to preserve its relationship with the repository, so you can receive or make updates as needed. Select the Clone button on a snippet to display the URLs to clone with SSH or HTTPS:

You can commit changes to a cloned snippet, and push the changes to GitLab.

Embed snippets

Public snippets can be shared and embedded on any website. You can reuse a GitLab snippet in multiple places, and any change to the source is reflected in the embedded snippets. When embedded, users can download it, or view the snippet in raw format.

To embed a snippet:

Confirm your snippet is publicly visible:

In your snippet’s Embed section, select Copy to copy a one-line script you can add to any website or blog post. For example:

Add your script to your file.

Embedded snippets display a header that shows:

Download snippets

You can download the raw content of a snippet. By default, they download with Linux-style line endings ( LF ). If you want to preserve the original line endings you need to add a parameter line_ending=raw (For example: https://gitlab.com/snippets/SNIPPET_ID/raw?line_ending=raw ). In case a snippet was created using the GitLab web interface the original line ending is Windows-like ( CRLF ).

Comment on snippets

With snippets, you engage in a conversation about that piece of code, which can encourage user collaboration.

Troubleshooting

Snippet limitations

Reduce snippets repository size

Because versioned snippets are considered as part of the namespace storage size, it’s recommended to keep snippets’ repositories as compact as possible.

For more information about tools to compact repositories, see the documentation on reducing repository size.

Источник

Git для новичков (часть 1)

Что такое Git и зачем он нужен?

С помощью Git-a вы можете откатить свой проект до более старой версии, сравнивать, анализировать или сливать свои изменения в репозиторий.

Репозиторием называют хранилище вашего кода и историю его изменений. Git работает локально и все ваши репозитории хранятся в определенных папках на жестком диске.

Так же ваши репозитории можно хранить и в интернете. Обычно для этого используют три сервиса:

Как работает

В итоге получается очень простой граф, состоящий из одной ветки ( main ) и четырех commit. Все это может превратиться в более сложный граф, состоящий из нескольких веток, которые сливаются в одну.

Об этом мы поговорим в следующих статьях. Для начала разберем работу с одной веткой.

Установка

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

Но для начала, все же установим сам Git.

Windows. Проходим по этой ссылке, выбираем под вашу ОС (32 или 64 битную), скачиваем и устанавливаем.

Для Mac OS. Открываем терминал и пишем:

Linux. Открываем терминал и вводим следующую команду.

Настройка

Вы установили себе Git и можете им пользоваться. Давайте теперь его настроим, чтобы когда вы создавали commit, указывался автор, кто его создал.

Открываем терминал (Linux и MacOS) или консоль (Windows) и вводим следующие команды.

Создание репозитория

Теперь вы готовы к работе с Git локально на компьютере.

Создадим наш первый репозиторий. Для этого пройдите в папку вашего проекта.

Теперь Git отслеживает изменения файлов вашего проекта. Но, так как вы только создали репозиторий в нем нет вашего кода. Для этого необходимо создать commit.

Отлично. Вы создали свой первый репозиторий и заполнили его первым commit.

Процесс работы с Git

Не стоит после каждого изменения файла делать commit. Чаще всего их создают, когда:

Создан новый функционал

Добавлен новый блок на верстке

Исправлены ошибки по коду

Вы завершили рабочий день и хотите сохранить код

Это поможет держать вашу ветки в чистоте и порядке. Тем самым, вы будете видеть историю изменений по каждому нововведению в вашем проекте, а не по каждому файлу.

Визуальный интерфейс

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

Но существуют и отдельные программы по работе с Git. Могу посоветовать эти:

Я не буду рассказывать как они работают. Предлагаю разобраться с этим самостоятельно.

Создаем свой первый проект и выкладываем на GitHub

Давайте разберемся как это сделать, с помощью среды разработки Visual Studio Code (VS Code).

Перед началом предлагаю зарегистрироваться на GitHub.

Создайте папку, где будет храниться ваш проект. Если такая папка уже есть, то создавать новую не надо.

Установите себе дополнительно анализаторы кода для JavaScript и PHP

Откройте вашу папку, которую создали ранее

После этого у вас появится вот такой интерфейс

Здесь будут располагаться все файлы вашего проекта

Здесь можно работать с Git-ом

Кнопка для создания нового файла

Кнопка для создания новой папки

Давайте теперь перейдем во вкладу для работы с Git-ом.

Откроется вот такое окно:

Кнопка для публикации нашего проекта на GitHub

Вы создали и опубликовали репозиторий на GitHub.

Теперь сделаем изменения в коде и попробуем их снова опубликовать. Перейдите во вкладку с файлами, отредактируйте какой-нибудь файл, не забудьте нажать crtl+s (Windows) или cmd+s (MacOS), чтобы сохранить файл. Вернитесь обратно во вкладу управления Git.

Если посмотреть на значок вкладки Git, то можно увидеть цифру 1 в синем кружке. Она означает, сколько файлов у нас изменено и незакоммичено. Давайте его закоммитим и опубликуем:

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

Добавляем наш файл для будущего commit

Отправляем наш commit в GitHub

Поздравляю, вы научились создавать commit и отправлять его в GitHub!

Это первая вводная статья по утилите Git. Здесь мы рассмотрели:

Как его устанавливать

Как его настраивать

Как инициализировать репозиторий и создать commit через консоль

Как на примере VS Code, опубликовать свой код на GitHub

Забегая вперед, советую вам погуглить, как работают следующие команды:

P.S. Для облегчения обучения, оставлю вам ссылку на бесплатный тренажер по Git.

Источник

Snippets API

Snippets API operates on snippets. Related APIs exist for project snippets and moving snippets between storages.

Snippet visibility level

Snippets in GitLab can be either private, internal, or public. You can set it with the visibility field in the snippet.

Valid values for snippet visibility levels are:

List all snippets for a user

Get a list of the current user’s snippets.

Get a single snippet

Get a single snippet.

Parameters:

Single snippet contents

Get a single snippet’s raw contents.

Parameters:

Snippet repository file content

Returns the raw file content as plain text.

Источник

Snippets

With GitLab snippets, you can store and share bits of code and text with other users. You can comment on, clone, and use version control in snippets. They can contain multiple files. They also support syntax highlighting, embedding, downloading, and you can maintain your snippets with the snippets API.

You can create and manage your snippets through the GitLab user interface, or by using the GitLab Workflow VS Code extension.

Create snippets

After you create a snippet, you can still add more files to it. In GitLab versions 13.0 and later, snippets are versioned by default.

Discover snippets

Change default visibility of snippets

Versioned snippets

In GitLab versions 13.0 and later, snippets (both personal and project snippets) have version control enabled by default.

This means that all snippets get their own underlying repository initialized with a default branch at the moment the snippet is created. Whenever a change to the snippet is saved, a new commit to the default branch is recorded. Commit messages are automatically generated. The snippet’s repository has only one branch. You can’t delete this branch, or create other branches.

Existing snippets were automatically migrated in 13.0. Their current content was saved as the initial commit to the snippets’ repository.

Filenames

Snippets support syntax highlighting based on the filename and extension provided for them. While you can submit a snippet without a filename and extension, it needs a valid name so the content can be created as a file in the snippet’s repository.

When upgrading from an earlier version of GitLab to 13.0, existing snippets without a supported filename are renamed to a compatible format. For example, if the snippet’s filename is http://a-weird-filename.me it is changed to http-a-weird-filename-me to be included in the snippet’s repository. As snippets are stored by ID, changing their filenames breaks direct or embedded links to the snippet.

Add or remove multiple files

If you need more than 10 files for your snippet, we recommend you create a wiki instead. Wikis are available for projects at all subscription levels, and groups for GitLab Premium.

Snippets with multiple files display a file count in the snippet list:

You can manage snippets with Git (because they’re versioned by a Git repository), through the Snippets API, and in the GitLab UI.

Clone snippets

Instead of copying a snippet to a local file, you may want to clone a snippet to preserve its relationship with the repository, so you can receive or make updates as needed. Select the Clone button on a snippet to display the URLs to clone with SSH or HTTPS:

You can commit changes to a cloned snippet, and push the changes to GitLab.

Embed snippets

Public snippets can be shared and embedded on any website. You can reuse a GitLab snippet in multiple places, and any change to the source is reflected in the embedded snippets. When embedded, users can download it, or view the snippet in raw format.

In your snippet’s Embed section, select Copy to copy a one-line script you can add to any website or blog post. For example:

Download snippets

You can download the raw content of a snippet. By default, they download with Linux-style line endings ( LF ). If you want to preserve the original line endings you need to add a parameter line_ending=raw (For example: https://gitlab.com/snippets/SNIPPET_ID/raw?line_ending=raw ). In case a snippet was created using the GitLab web interface the original line ending is Windows-like ( CRLF ).

Comment on snippets

With snippets, you engage in a conversation about that piece of code, which can encourage user collaboration.

Mark snippet as spam

Administrators on self-managed GitLab instances can mark snippets as spam.

GitLab forwards the spam to Akismet.

Troubleshooting

Snippet limitations

Reduce snippets repository size

Because versioned snippets are considered as part of the namespace storage size, it’s recommended to keep snippets’ repositories as compact as possible.

For more information about tools to compact repositories, see the documentation on reducing repository size.

Cannot enter text into the snippet text box

Источник