>Zina: /* Добавить свой локальный репозиторий в GitLab, GitHub или Bitbacket */

2022-05-29T13:35:36Z

Добавить свой локальный репозиторий в GitLab, GitHub или Bitbacket

Нова сторінка

[https://training.github.com/downloads/ru/github-git-cheat-sheet/ Шпаргалка по Git от GitHub - GitHub Cheatsheets]

== Установка Git в системе ==

=== Linux ===

<source lang="bash">
sudo apt install git
</source>

=== Windows ===

Скачать Git для Windows: https://git-for-windows.github.io/

Установить, соглашаясь со всеми настроками по умолчанию.

Скачать и установить Git Credential Manager for Windows: https://github.com/Microsoft/Git-Credential-Manager-for-Windows/releases/latest

Запустить PowerShell и установить режим авторизации:

git config --global credential.helper wincred

<div class="note">
'''Вариант установки через командную строку'''

Запустите PowerShell: <kbd>Win</kbd>-<kbd>R</kbd> — <code>powershell</code> — <kbd>Enter</kbd>

Проверьте версию — должна быть не ниже 5:

<source lang="powershell">$PSVersionTable</source>

Установите менеджер пакетов Scoop:

<source lang="powershell">
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
iwr -useb get.scoop.sh | iex
</source>

Установите Git:

scoop install git

Установите модуль [https://github.com/dahlbyk/posh-git posh-git]:

<source lang="powershell">
Install-Module -Name posh-git -Force
Get-Module -Name posh-git -ListAvailable
</source>

Установите режим авторизации:

git config --global credential.helper wincred
</div>

== Первоначальная настройка Git ==

=== GitLab, GitHub, BitBucket ===

Чтобы иметь возможность работать с удаленными репозиториями GitLab, GitHub или BitBucket нужно указать в глобальных настройках Git логин и имейл вашего аккаунта.

<source lang="bash">
git config --global user.email "user@zina.design"
git config --global user.name "user"
</source>

Проверить:

git config --list

На GitLab можно узнать свой <code>user.email</code> здесь: https://gitlab.com/-/profile
<br>Чтобы узнать свой <code>user.name</code>, кликните на иконке профиля в правом верхнем углу.

=== SSH key ===

Чтобы было проще авторизоваться, для GitHub и GitLab нужно создать SSH key (измените <code>user@zina.design</code> на ваш имейл):

<source lang="bash">
ssh-keygen -t ed25519 -C "user@zina.design"
</source>

Скопируйте ключ в буфер:

gedit ~/.ssh/id_ed25519.pub

и вставьте его в профиль:

* https://github.com/settings/keys
* https://gitlab.com/-/profile/keys

Проверить авторизацию:

ssh -T -p 443 git@ssh.github.com
ssh -T git@gitlab.com

=== Исключения ===

Также добавить в глобальный <code>.gitignore</code> исключения для характерных для вашего рабочего окружения файлов:

<source lang="bash">
git config --global core.excludesfile ~/.gitignore_global
touch ~/.gitignore_global
</source>

Пример содержимого <code>~/.gitignore_global</code>:

*.sublime-project
*.sublime-workspace
*.DS_Store
backup/
art/
.sass-cache/
node_modules/
bower_components/
resources/

==== Хранение в Git пустой директории ====

Git не хранит пустые папки. Но они бывают нужны для создания нужной структуры директорий — например, папка для временных или кешированных файлов.

При этом нам нужно отключить слежение за файлами в этих папках.

Для таких папок создаем внутри папки файл <code>.gitkeep</code> и в <code>.gitignore</code> добавляем:

/cache/*
!.gitkeep

Таким образом мы исключаем все файлы внутри папки <code>cache</code>, кроме <code>.gitkeep</code>.

==== Удаление файлов из кэша, которые были добавлены в <code>.gitignore</code> ====

Допустим, мы решили добавить в <code>.gitignore</code> файл <code>temp.txt</code>, который был уже закомиччен.

Но простого добавления файла в <code>.gitignore</code> недостаточно — Git все равно продолжит отслеживать изменения в этом файле, потому что он есть в репозитории.

Чтобы Git начал игнорировать этот файл, нужно удалить его из кэша:

<source lang="bash">
git rm --cached temp.txt
</source>

== Установка Git в проекте ==

=== Импортировать существующий репозиторий ===

Адрес репозитория проекта на GitHub и GitLab имеет вид:

<nowiki>https://gitlab.com/USERNAME/PROJECT</nowiki>

где:

* USER – имя пользователя-владельца;
* PROJECT – имя проекта.

Импортирование репозитория на локальный компьютер делается командой <code>git clone</code> вида:

git clone АДРЕС_РЕПОЗИТОРИЯ

<code>АДРЕС_РЕПОЗИТОРИЯ</code> можно скопировать по нажатию на кнопку <code>Clone</code> на странице репозитория.

Адрес может быть в форматах SSH и HTTPS, это не имеет особого значения:

git clone git@gitlab.com:'''USER'''/'''PROJECT'''.git
git clone <nowiki>https://gitlab.com/</nowiki>'''USER'''/'''PROJECT'''.git

Репозиторий будет скачан в папку с именем проекта. Ее можно изменить — просто добавить в конец команды имя новой папки:

git clone АДРЕС_РЕПОЗИТОРИЯ НОВАЯ_ПАПКА

=== Создать новый локальный репозиторий ===

Перейдите в папку вашего проекта и создайте локальный репозиторий проекта:

git init

Добавьте в список исключений те файлы и папки, которые не нужно отслеживать (и которых нет в <code>~/.gitignore_global</code>):

vim .gitignore

Проверьте статус проекта:

git status

Добавьте в репозиторий все файлы проекта:

git add --all

Создайте первый коммит:

git commit -m "Initial commit"

=== Добавить свой локальный репозиторий в GitLab, GitHub или Bitbacket ===

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

* https://github.com/new
* https://gitlab.com/projects/new

Добавьте удаленный репозиторий в локальный и отправьте ваши локальные файлы в удаленный:

git remote add origin git@gitlab.com:zinadesign/ИМЯ-РЕПОЗИТОРИЯ.git
git push -u origin main

Аналогично в Bitbucket:

git remote add origin ssh://git@bitbucket.org/zinadz/ИМЯ-РЕПОЗИТОРИЯ.git
git push -u origin master

=== Редактирование свойств локального проекта ===

git config --edit --local

Например, может быть полезно, чтобы сменить подключение с https:// на SSH.

== Часто используемые команды ==

Выполнять в корневой папке проекта.

=== Просмотр состояния Git и вашего кода ===

Показать изменения в ветке:

git status

Показать разницу между незакоммиченным и закоммиченным кодом:

git diff

Список сделанных коммитов:

git log

=== Сохранение изменений кода ===

Добавить файлы в коммит:

<source lang="bash">
git add
</source>

* <code>git add .</code> — добавить все файлы и папки
* <code>git add path/to/file</code> — добавить конкретный файл/папку
* <code>git add dir/*</code> — добавить все файлы в папке (* — может быть часть имени файла)

Коммит изменения (все еще на локальном компьютере):

<source lang="bash">
git commit -m "some text"
</source>

Залить изменения в удаленный репозиторий. Удаленных репозиториев может быть несколько. <code>origin</code> — так принято называть основной репозиторий:

<source lang="bash">
git push origin master
</source>

Скачать на локальную машину изменения с удаленного репозитория:

<source lang="bash">
git pull
</source>

При этом нужно понимать, что <code>git add</code> — лишь сохраняет состояние файлов в локальном репозитории.

Например, изменяем some.txt и хотим сохранить текущее состояние, но коммитить пока рано. Делаем <code>git add some.txt</code>. Потом снова вносим изменения в some.txt и решаем закоммитить. Фиксируем состояние и делаем коммит:

<source lang="bash">
git add some.txt
git commit -m "Описание изменений some.txt"
</source>

Снова работаем с файлом и хотим добавить их другим коммитом. Делаем:

<source lang="bash">
git add some.txt
git commit -m "Описание новых изменений some.txt"
</source>

Ветку в git можно понимать как указатель на коммит. Каждый новый коммит сдвигает этот указатель выше.

=== Если что-то пошло не так ===

Восстановить файл в старой версии:

git restore --source <commit_hash_id> <file_path>

<code>commit_hash_id</code> — берется с <code>git log</code>.

Есть другая, более старая команда, которая делает то же самое:

git checkout <commit_hash_id> -- <file_path>

Сейчас рекомендуют использовать <code>git restore</code>: [https://medium.com/blue-harvest-tech-blog/git-2-23-0-forget-about-checkout-and-switch-to-restore-ac2682b737b3 Git 2.23.0: Forget about checkout, and switch to restore.]

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

Чаще всего это конфликты по контенту и тогда просто открываем файл и правим в секциях:

<source lang="bash">
<< HEAD
====
>> hash
</source>

== Типовые сценарии работы с git ==

<source lang="bash">
git diff
git add --all
git commit -m "some text"
git push origin master
</source>

Если работа над кодом велась по тикету, то нужно в тексте коммита указывать <code>see #nnn</code>, где nnn — номер тикета.

=== Получить код из Bitbucket на локальную машину ===

<source lang="bash">
git pull origin master
</source>

Если на локальной машине есть код, которого нет в удаленном репозитории, то нужно:

* или закоммитить его: <code>git commit -m "My message"</code>
* или можно от него отказаться и полностью заменить на версию из удаленного репозитория: <code>git reset --hard</code>

[https://git-scm.com/book/ru/v1/Основы-Git-Работа-с-удалёнными-репозиториями Работа с удалёнными репозиториями]

== Ветки и версии ==

Список веток:

git branch

Получить список всех веток с удаленного репозитория:

git branch -r

Переключиться на удаленную ветку <code>origin/v5-beta</code>:

git checkout origin/v5-beta

Посмотреть последний коммит на каждой из веток:

git branch -v

Посмотреть те ветки, которые вы уже слили с текущей:

git branch --merged

Увидеть все ветки, содержащие наработки, которые вы пока ещё не слили в текущую ветку:

git branch --no-merged

Удалить ветку:

git checkout master
git branch -d ИМЯ_ВЕТКИ

=== Создание новой ветки ===

Создать ветку <code>develop</code> для разработки и сразу переключиться в нее:

git checkout -b develop

Дальше работаем как обычно. После написания кода коммитим его и загружаем в удаленный репозиторий ветку <code>develop</code>:

<source lang="bash">
git add .
git commit -m "Описание изменений"
git push origin develop
</source>

Скачать с удаленного репозитория ветку <code>develop</code>:

<source lang="bash">
git checkout -b develop origin/develop
</source>

=== Объединение веток ===

Если решили включить код из <code>develop</code> ветки в основную <code>master</code>, объединяем ветки таким образом:

<source lang="bash">
git checkout master
git merge develop
</source>

Вернутся в основную ветку <code>master</code>:

git checkout master

=== Тэги ===

Посмотреть список существующих тегов:

git tag

Создать новый тег (он будет указывать на верхний коммит в ветке <code>master</code>):

git tag v1.0.0

О правилах именования версий — [https://getcomposer.org/doc/04-schema.md#version здесь] или [https://stackoverflow.com/questions/2006265/is-there-a-standard-naming-convention-for-git-tags здесь].

Залить теги в удаленный репозиторий:

git push --tags

== Удаление файлов ==

=== Удаление файлов в репозитории на Bitbacket ===

Чтобы удалить в репозитории Bitbacket файлы, которые раньше были удалены на локальной машине:

# <code>git add --all</code> — закоммитить удаленние файлов
# <code>git status</code> — убедиться, что удаленные файлы попали в «Changes to be committed»
# <code>git commit -m "delete old"</code>
# <code>git push origin master</code>

=== Удаление untracked файлов ===
<code>git clean -d -f</code>

=== Отменить удаление файла ===

<source lang="bash">
git rev-list -n 1 HEAD -- sites/default/settings_local.example.php
40c51f08cf20a8b0e26fc3de5acabfdd0fd20625
shmel@zd28:~/projects/artluhansk.com$ git checkout 40c51f08cf20a8b0e26fc3de5acabfdd0fd20625^ -- sites/default/settings_local.example.php
shmel@zd28:~/projects/artluhansk.com$ git status
On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)

new file: sites/default/settings_local.example.php
git commit -m "вернул удаленный settings_local.example.php"
git push
</source>

== Ссылки ==

* [https://dev.to/devdefinitive/25-git-commands-i-use-daily-and-you-should-know-1kj5 25 Git commands I use daily and you should know - DEV Community]
* [https://dev.to/nsadisha/new-post-355m#synchronize-changes Github git cheat sheet - DEV Community 👩‍💻👨‍💻]
* [https://dev.to/inezabonte/how-to-use-github-and-git-for-beginners-5dm3 How to Use GitHub and Git for Beginners]
* [https://dev.to/imabtiwari/life-saving-git-commands-42p0 Life-saving git commands]
* [https://guides.github.com/activities/hello-world/ Hello World · GitHub Guides]
* [http://j.jgs.im/tech/git/workflow Workflow - JGS]
* [http://tproger.ru/translations/most-common-git-screwupsquestions-and-solutions/ Типичный программист — Самые типичные ошибки/вопросы по git и способы их решения]
* [http://lj.rossia.org/users/k001/665228.html Более чем краткое введение в git]
* [http://git-scm.com/book/ru/v1 Pro Git v1] на русском ([https://cloud.github.com/downloads/GArik/progit/progit.ru.pdf PDF])
* [https://www.dropbox.com/s/4lcq42ew84jkg4t/progit-2.0.0.pdf?dl=0 Pro Git v2] english PDF
* [https://www.dropbox.com/sh/3001ah7ma50hxqf/AABNsY_4cLg1L4snGXIvQ2usa?dl=0 Думай как Git]
* http://githowto.com/ru/
* [http://eax.me/git-commands/ Моя шпаргалка по работе с Git]
* [https://bitbucket.org/Digiman/devbook/wiki/Appendix/Installing_Git_for_Windows Установка Git for Windows]
* '''Настройка Git для работы с Bitbucket'''
** [https://bitbucket.org/Digiman/devbook/wiki/Part2/GitConfig Настройка Git и удаленного репозитория (аккаунта на Bitbucket)]
** [https://bitbucket.org/Digiman/devbook/wiki/Part2/WorkWithBitbucket Глава 2 Работа с Bitbucket]

Git - Історія редагувань

>Zina: /* Добавить свой локальный репозиторий в GitLab, GitHub или Bitbacket */