BIGLOBE クラウドホスティング開発お役立ちパック GitLab 利用マニュアル 1.0 版 (2013 年 7 月 3 日 ) ビッグローブ株式会社 1 Copyright 2013 BIGLOBE. All Rights Reserved

Size: px

Start display at page:

ゆずさかやぬま
4 years ago
Views:

1 BIGLOBE クラウドホスティング開発お役立ちパック GitLab 利用マニュアル 1.0 版 (2013 年 7 月 3 日 ) ビッグローブ株式会社 1

2 0. はじめに GitLab って何だろう... 5 Git とは... 5 GitLab とは GitLab をはじめる準備をしよう ( 管理者作業 )... 6 事前準備... 6 ログイン... 8 システム管理者のパスワードの変更 GitLab でユーザを追加しようユーザの追加 GitLab を使ってみようログインパスワードの変更 GitLab でプロジェクトを作成しよう Namespace とはプロジェクトの追加プロジェクトの Namespace の変更 GitLab でチームを作成しようチームの作成 GitLab でプロジェクトにチームメンバーを追加しようプロジェクトのチームメンバーを追加チームメンバーにユーザを追加する方法チームメンバーにチームを追加する方法チームメンバーに他プロジェクトのチームメンバーを追加する方法グループを作成しようグループの作成開発環境から GitLab のリポジトリを操作しよう開発環境に Git を導入 Git の設定開発環境から GitLab リポジトリを操作 SSH 鍵の設定 SSH 接続で push HTTPS 接続で push

3 3.6. GitLab でブランチを分けて開発しようブランチとはブランチの作成 GitLab でコミット履歴を閲覧しようコミット履歴の閲覧 GitLab でソースをダウンロードしようブランチのソースをダウンロード GitLab でブランチの差を比較しようブランチの差分を比較 GitLab でブランチをマージしようブランチをマージ応用編 GitLab で問題を共有しよう問題を登録しよう応用編 GitLab で wiki を使ってみよう Wiki を新規作成応用編 GitLab でチャットを使ってみよう前準備チャットの使用方法応用編 GitLab でスニペットを作成しよう前準備スニペットの使用方法注意事項ご注意

4 0. はじめに本マニュアルでは開発お役立ちパックにおける下図の赤枠部分について利用例を説明しています ( 注意 ) ご利用にあたっては各 OSS に関連する設定や DB パスワード変更等を行うことを推奨します下記環境変更マニュアルをご参照ください ( コントロールパネルへのログイン必要 ) 4

5 1. GitLab って何だろう Git とは Git はオープンソースの分散型バージョン管理システムです開発者が各々専用の作業リポジトリ ( 管理 DB) を持ちそこにファイルをコミット ( 登録 ) しますコミットしたファイルをプッシュ / プル ( 展開と取得 ) することで全体と共有しソフトウェアの開発を行いますリポジトリをクローン ( コピー ) することでいつでも開発に参加できます GitLab とは GitLab はオープンソースの Git リポジトリ管理システムですリポジトリ情報の閲覧やコードレビュー Wiki イシュートラッカーマージリクエストといった機能を備えた Web アプリケーションです各機能の詳細な説明は後述します 5

6 2. GitLab をはじめる準備をしよう ( 管理者作業 ) 事前準備 GitLab をはじめる前に GitLab のサーバ設定を変更する必要があります GitLab が動いているサーバに root ユーザでログインして以下の手順で設定を変更してください 1 git ユーザに切り替えてください # su - git 2 GitLab の設定を変更してください $ cd ~/gitlab/config $ vi gitlab.yml : ## GitLab settings host: localhost となっているのでリポジトリ URL として gitlab: アクセス可能な ip アドレスまたは FQDN に変更します ## Web server settings 例 :host: host: [GitLab が動いているサーバの IP アドレスまたは FQDN] port: 443 https: true # Uncomment and customize to run in non-root path # Note that ENV['RAILS_RELATIVE_URL_ROOT'] in config/puma.rb may need to be changed relative_url_root: /gitlab # Uncomment and customize if you can't use the default user to run GitLab (default: 'git') # user: git : 6

7 3 root ユーザに切り替えてください $ exit 4 GitLab と redis のサービスを停止してください # /etc/init.d/gitlab stop # /etc/init.d/redis stop 5 GitLab が停止していることを確認してください # ps aux grep git 6 GitLab と redis のサービスを起動してください # /etc/init.d/redis start # /etc/init.d/gitlab start 7

8 ログインインストール直後の GitLab にはシステム管理者しかいないためシステム管理者でログインします GitLab にアクセスするとログイン画面が表示されますログインフォームにユーザ名パスワードを入力してログインしてください GitLab をインストールした直後であれば以下のユーザ名パスワードでログインできますシステム管理者でログインするとサンプルのソースコードをいくつか確認できます URL: [YOUR_SERVER_HOST] /gitlab ユーザ名パスワード :5iveL!fe 8

9 システム管理者のパスワードの変更システム管理者のパスワードがデフォルトのままだと誰でもシステム管理者として GitLab にログインできてしまうため変更します画面右上の (My Profile) をクリックしてください Account タブをクリックしてください 9

10 新しいパスワードを 2 回入力し Save password をクリックすると変更が完了します 10

11 2.1. GitLab でユーザを追加しようユーザの追加 GitLab にログインできるユーザを新たに追加します管理者権限を持つユーザでログインし画面右上の (Admin area) をクリックしてください New User をクリックしてください 11

12 New user についての下記の情報を入力し Create user をクリックすると登録が完了します 12

13 Account 項目 Name Username 表示名を入力してくださいユーザ名を入力してくださいメールアドレスを入力してください内容 Password 項目 Password Password confirmation Generate random password 内容パスワードを入力してくださいもう一度パスワードを入力してくださいチェックするとランダムなパスワードを生成します生成されたパスワードは確認できません Access 項目 Projects limit Can create group Can create team Administrator 内容管理者となれるプロジェクトの上限を入力して下さいチェックするとグループの作成権限を持ちますチェックするとチームの作成権限を持ちますチェックすると管理者権限を持ちます Profile 項目 Skype Linkedin Twitter 内容 Skype の情報を入力してください Linkedin の情報を入力してください Twitter の情報を入力してください 13

14 3. GitLab を使ってみようログイン管理者から通知されたアカウントとパスワードでログインしてください 14

15 パスワードの変更管理者から割り当てられたパスワードをそのまま使用するのは危険なので他人が知らないパスワードに変更してください画面右上の (My Profile) をクリックし Account タブをクリックしてください新しいパスワードを 2 回入力し Save password をクリックすると変更が完了します 15

16 3.1. GitLab でプロジェクトを作成しよう Namespace とはプロジェクトは作成する際に Namespace と関連付けられます Namespace はプロジェクト名の衝突の可能性を低減し参照を容易にします同一のプロジェクト名であっても Namespace が異なれば登録が可能ですプロジェクトの追加画面右上の (Create New Project) をクリックしてくださいプロジェクト名と Namespace を入力し Create project をクリックしてください半角英数でプロジェクト名を入力してくださいプロジェクトを作成すると /home/git/repositories/(namespace) 配下に Git リポジトリが作成されます 16

17 既存のリポジトリを用いる場合は Import existing repository? をクリックしインポートするリポジトリを指定してくださいプロジェクト作成後作成されたリポジトリに接続する SSH/HTTPS の URL を確認できます 17

18 SSH 鍵の設定がされていない場合プロジェクト画面に次の様なメッセージが表示されます SSH 接続を用いてリポジトリに接続する場合は SSH 鍵の設定を行ってください SSH 鍵の設定方法は 3.4. 開発環境から GitLab のリポジトリを操作しようを参照してくださいプロジェクトの Namespace の変更変更を行うプロジェクトを開き Settings をクリックし Transfer をクリックしてください変更後の Namespace を選択し Transfer をクリックしてください Namespace を変更した場合 Git リポジトリのパスが変更されるので注意してください 18

19 3.2. GitLab でチームを作成しようチームの作成 GitLab でチームを利用することでユーザをまとめて管理することが出来ます GitLab のアイコンをクリックし Dashboard を開いてください Teams タブを選択し New Team をクリックしてくださいチーム名と詳細を入力し Create team をクリックしてください 19

いチームの作成が完了すると Members をクリックし New Team Member をクリックしてくださ下記の情報を入力し Add users をクリックしてください New Team member(s) 項目内容 People メンバーに追加可能なユーザ一覧がプルダウンで表示されます

20 いチームの作成が完了すると Members をクリックし New Team Member をクリックしてくださ下記の情報を入力し Add users をクリックしてください New Team member(s) 項目内容 People メンバーに追加可能なユーザ一覧がプルダウンで表示されます追加するユーザを選択してください複数同時に選択できます Project Access 追加するユーザの権限を設定してください各権限の詳細は以下のページから確認できます URL: [YOUR_SERVER_HOST] /gitlab /help/permissions Team Admin? チェックするとこのチームの管理権限を持ちます 20

21 3.3. GitLab でプロジェクトにチームメンバーを追加しようプロジェクトのチームメンバーを追加 GitLab のプロジェクトに追加されているユーザをそのプロジェクトのチームメンバーといいますプロジェクトの作成直後のチームメンバーはプロジェクト作成者しか存在しません本手順ではプロジェクトにチームメンバーの追加を行いますプロジェクトにチームメンバーを追加できるのは権限をもったユーザのみですチームメンバーにユーザを追加する方法チームメンバーを追加したいプロジェクトのページへ移動してください Settings をクリックし Team をクリックしてチームメンバーの設定画面を開いてくださいユーザをチームメンバーとして追加するには New Team Member をクリックしてください 21

22 下記の情報を入力し Add users をクリックしてください New Team member(s) 項目内容 People チームメンバーに追加可能なユーザ一覧がプルダウンで表示されます追加するユーザを選択してください複数同時に選択できます Project Access 追加するユーザの権限を設定してください各権限の詳細は以下のページから確認できます URL: [YOUR_SERVER_HOST] /gitlab /help/permissions 22

23 チームメンバーにチームを追加する方法チームをチームメンバーとして追加するには Assign project to Team of users をクリックしてください 23

24 追加するチームと与える権限を選択し Assign をクリックしてください Assign project to team of users 項目内容 Team チームメンバーに追加するチームを選択してください Permission 追加するチームメンバーの権限を設定してください各権限の詳細は以下のページから確認できます URL: [YOUR_SERVER_HOST] /gitlab /help/permissions 24

25 チームメンバーに他プロジェクトのチームメンバーを追加する方法他プロジェクトに登録されているチームメンバーを一度にチームメンバーとして追加するには Import team from another project をクリックしてください追加元となるプロジェクトを選択し Import をクリックしてください Import team from another project 項目内容 Project チームメンバーに追加するプロジェクトを選択してください 25

26 3.4. グループを作成しようグループの作成 GitLab でグループを利用することでプロジェクトをまとめて管理することが出来ます GitLab のアイコンをクリックし Dashboard を開いてください Groups タブを選択し New Group をクリックしてくださいグループ名と詳細を入力し Create group をクリックしてください 26

27 すグループの作成が完了すると New Project をクリックでグループ内にプロジェクトを作成できま 27

3.5. 開発環境から GitLab のリポジトリを操作しよう開発環境に Git を導入ローカルの PC 端末など GitLab が動いているサーバ以外の場所で開発を行う場合その環境に Git を導入する必要があります Red Hat/Fedora/CentOS の場合 $ yum install git Windows の場合以下の URL から Windows の最新版の Git

28 3.5. 開発環境から GitLab のリポジトリを操作しよう開発環境に Git を導入ローカルの PC 端末など GitLab が動いているサーバ以外の場所で開発を行う場合その環境に Git を導入する必要があります Red Hat/Fedora/CentOS の場合 $ yum install git Windows の場合以下の URL から Windows の最新版の Git をインストールできます URL: これ以外にも GUI ベースの Git クライアントなどたくさんあります Git の設定ここでは Windows の場合を例に手順を紹介しますが基本は環境が異なっても一緒です Git Bash を起動してくださいプロキシの設定が必要な場合以下のコマンドを実行し設定を追加してください $ git config --system http.proxy プロキシサーバのアドレス ]:[ プロキシサーバのポート番号 ] $ git config --system https.proxy プロキシサーバのアドレス ]:[ プロキシサーバのポート番号 ] 28

29 開発環境から GitLab リポジトリを操作開発環境のリポジトリと GitLab リポジトリをリモートで接続し操作します接続には SSH か HTTPS を用います以下にそれぞれの接続方法を示します接続に用いる URL は 3.1.GitLab でプロジェクトを作成しようを参照してください SSH 鍵の設定 SSH で接続する為に SSH 鍵の設定を行ってください画面右上の (My Profile) をクリックし Add Public Key をクリックしてください 29

30 here をクリックすると SSH 鍵の生成方法を確認できます開発環境から次のコマンドを実行し SSH 鍵を生成します 30

31 (Git bash の実行結果 ) $ ssh-keygen -t rsa -C "user1@example.org" Generating public/private rsa key pair. Enter file in which to save the key (/c/users/user1/.ssh/id_rsa): Enter passphrase (empty for no passphrase): パスフレーズを入力 Enter same passphrase again: パスフレーズの確認 Your identification has been saved in /c/users/user1/.ssh/id_rsa. Your public key has been saved in /c/users/user1/.ssh/id_rsa.pub. The key fingerprint is: 9a:**:**:**:**:**:**:**:**:**:**:**:**:**:**:c5 user1@example.org Enter 以下の結果をコピーし Key として設定してください $ cat ~/.ssh/id_rsa.pub ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAuZrH9n3NTTPCqJpKnuFWLPqOGyKrCHvdy37SpsM7 ************************************************************** ************************************************************** ************************************************************** ************************************************************** aslw/ieqtpjqrm69+rw== user1@example.org 31

32 Title と Key を入力し Save をクリックしてください SSH 鍵が設定されます 32

33 SSH 接続で push 例として GitLab の SampleProject という名前のプロジェクトのリポジトリに対して SSH 接続で操作を行います開発環境から次の手順を実行し SSH 接続でリポジトリを生成します 33

34 Git にユーザ設定を行ってください $ git config --global user.name "user1" $ git config --global user. "user1@example.org" 開発環境にリポジトリを作成してください $ mkdir sampleproject $ cd sampleproject $ git init 作成したリポジトリの中に push するファイルを格納してください $ vi build.xml $ mkdir document $ vi document/readme.txt ファイルをコミットしてください $ git add * $ git commit -m 'first commit' ファイルを GitLab リポジトリに push してください $ git remote add origin git@[your_server_host]:[namespace]/sampleproject.git $ git push -u origin master 34

35 HTTPS 接続で push 例として GitLab の SampleProject という名前のプロジェクトのリポジトリに対して HTTPS 接続で操作を行います GitLab リポジトリを開発環境に clone してください $ git clone sampleproject.git clone した開発環境のリポジトリの中に push するファイルを格納してください $ vi build.xml $ mkdir document $ vi document/readme.txt ファイルをコミットしてください $ git add * $ git commit -m 'first commit' ファイルを GitLab リポジトリに push してください $ git push origin master 35

36 3.6. GitLab でブランチを分けて開発しようブランチとは Git にはブランチという機能が備わっていますブランチとは履歴を分岐して記録していく為のものです分岐したブランチは他ブランチの影響を受けないため複数の変更を同時に進めることができます分岐したブランチは他ブランチとマージすることで 1つのブランチにまとめることが出来ますブランチの作成例として v1.0 という名前のブランチを作成します開発環境のリポジトリでブランチを作成し push する手順を以下に示しますブランチを作成してください $ git branch v1.0 ブランチが作成されたことを確認してください * の付いているブランチが現在作業中のブランチとなります $ git branch * master v1.0 作業ブランチを切り替えてください $ git checkout v1.0 Switched to branch 'v1.0' $ git branch master * v1.0 36

37 ブランチ v1.0 上で開発を行ってください $ vi build.xml $ vi document/readme.txt ブランチ v1.0 の作業情報をコミットしてください $ git add * $ git commit -m 'first commit' ブランチ v1.0 を GitLab リポジトリに push してください GitLab リポジトリにブランチ v1.0 が作成されます $ git push origin v1.0 37

38 3.7. GitLab でコミット履歴を閲覧しようコミット履歴の閲覧コミット履歴を閲覧したいプロジェクトのページへ移動してください Files をクリックし history をクリックしてくださいプルダウンからブランチ毎の履歴を確認できます閲覧したいコミット履歴をクリックしてください 38

39 39

40 コミット内容の詳細を確認しコメントを残すことができますコメントを入力し Add Comment をクリックしてください 40

41 3.8. GitLab でソースをダウンロードしようブランチのソースをダウンロードソースのダウンロードを行うプロジェクトのページへ移動してください Commits をクリックして Branches をクリックしてくださいダウンロードを行うブランチの Download をクリックしてください 41

42 3.9. GitLab でブランチの差を比較しようブランチの差分を比較ブランチの差分を比較したいプロジェクトのページへ移動してください Commits をクリックし Compare をクリックしてください Compare View に比較するブランチを入力し Compare をクリックしてください 42

43 ブランチの差分を確認できます 43

44 3.10. GitLab でブランチをマージしようブランチをマージブランチをマージすることで分岐したブランチを1つのブランチにまとめることが出来ます GitLab からブランチのマージを行った場合マージ元に選択したブランチの変更情報がマージ先のブランチに書き込まれますブランチのマージを行うプロジェクトのページへ移動してください Merge Requests をクリックして New Merge Request をクリックしてください 44

45 下記の情報を入力し Submit merge request をクリックしてください From(Head Branch) に設定したブランチの変更情報を To(Base Branch) に設定したブランチに書き込みます Select Branches 項目 From(Head Branch) To(Base Branch) 内容マージ元となるブランチを選択してくださいマージ先となるブランチを選択してください Fill info 項目 Title Assign to Milestone 内容作成するマージリクエストのタイトルを入力してください担当者を選択してください事象を選択してください 45

46 マージ内容を確認しコメントを残すことができますコメントを入力し Add Comment をクリックしてください 46

47 Diff をクリックしてください To(Base Branch) に設定されたブランチへのマージ内容を確認できます 47

48 Accept Merge Request をクリックしてくださいマージを実行します 48

49 3.11. 応用編 GitLab で問題を共有しよう問題を登録しよう対象プロジェクトページで Issue を選択してください New Issue をクリックしてください 49

50 Issue の情報を入力して Submit new issue をクリックしてくださいスニペット情報項目 Subject Assign to Milestone Labels Details 題名を入力してください担当者を選択してください問題の事象を選択してくださいラベルを入力してください問題の詳細を入力してください内容 50

51 登録した問題が表示されます問題一覧画面を表示すると登録した情報が表示されます 51

52 3.12. 応用編 GitLab で wiki を使ってみよう GitLab では Wiki を利用することができます Wiki とは Web 上でサイズやフォントを指定することのできる文章メモの事です Wiki を新規作成対象プロジェクトページで Wiki を選択してください Wiki の情報を入力し Save をクリックしてください 52

53 Wiki 項目 Format Content Commit message 内容 Wiki の記載方法を Markdown または RDoc から選択してください Wiki の内容を入力してくださいコミット時のメッセージを入力してください入力した内容が表示されます 53

54 3.13. 応用編 GitLab でチャットを使ってみよう GitLab でチャットを利用してリアルタイムコミュニケーションを取ることができます前準備対象プロジェクトページで Settings を選択してくださいプロジェクト設定画面で Features: の Wall を選択し Save をクリックしてください Wall タブが表示されます 54

55 チャットの使用方法対象プロジェクトページで Wall を選択してくださいコメントを入力し Add Comment をクリックしてくださいコメント内容が表示されます 55

56 3.14. 応用編 GitLab でスニペットを作成しよう GitLab ではスニペットを利用することが出来ますスニペットはよく使われるコードやお手本となるコードを保存しておきチームメンバーはそれを参照することができます前準備対象プロジェクトページで Settings を選択してくださいプロジェクト設定画面で Features: の Snippets を選択し Save をクリックしてください Snippets タブが表示されます 56

57 スニペットの使用方法対象プロジェクトページで Snippets を選択してください Add new snippet をクリックしてくださいスニペット情報を入力し Save をクリックしてください 57

58 スニペット情報項目 Title Lifetime File 内容スニペットの題名を入力してくださいスニペットの有効期間を選択してくださいファイル名およびファイル内容を入力してくださいスニペットが表示されます 58

60 BIGLOBE クラウドホスティング開発お役立ちパック GitLab 利用マニュアル 1.0 版 2013 年 7 月ビッグローブ株式会社 60

情報処理概論（第二日目）

情報処理概論（第二日目）実習資料 Linux 入門講習会九州大学情報基盤研究開発センター注意 : この内容は wisdom.cc.kyushu-u.ac.jp の任意の ID で利用できますが, ファイルの削除等を含んでいるので各コマンドの意味を理解するまでは講習会用 ID で利用することをお勧めします. 1 実習 1 ログインファイル操作ディレクトリの作成ファイルの移動, コピー, 削除ログアウト 2 ログイン

BIGLOBE クラウドホスティング 開発お役立ちパック GitLab 利用マニュアル 1.0 版 (2013 年 7 月 3 日 ) ビッグローブ株式会社 1 Copyright 2013 BIGLOBE. All Rights Reserved

BIGLOBE クラウドホスティング開発お役立ちパック GitLab 利用マニュアル 1.0 版 (2013 年 7 月 3 日 ) ビッグローブ株式会社 1 Copyright 2013 BIGLOBE. All Rights Reserved