Memo/git/GitHub

https://dexlab.net:443/pukiwiki/index.php?Memo/git/GitHub 		 

GitHub †

↑

OSSへの貢献 Issue/PullRequestの作り方 †

↑

PRやIssueからファイルへのリンク †

  • 以下みてもPR上で「...」が表示されない。
↑

Code Scanning: コードの脆弱性とエラーを自動的にスキャン †

有効化手順:

↑

SubvesionからGitHubへ移行 †

  • 環境
    • OS: CentOS 7
    • git version 1.8.3.1

localにある「file:///var/www/svn/dev/」をgithub private repoへ移行する:

  1. 空のgit repoを作成 
    mkdir -p git-svn/dev/
cd git-svn/dev/

# svnのrevを確認
svn info file:///var/www/svn/dev/
  2. git repoの初期化: .git/config に保存される。
    • 一般的なsvn: 以下のように branches, tags, trunkがある場合 
      svn ls file:///var/www/svn/repo/
branches/
tags/
trunk/

git svn init -s --prefix=svn/ --no-minimize-url file:///var/www/svn/dev/
    • trunk等が無く、直接ファイルが置いてある場合。「--trunk=/」を追加する 
      svn ls file:///var/www/svn/repo/
dir1
dir2
...

git svn init -s --prefix=svn/ --no-minimize-url --trunk=/ file:///var/www/svn/dev/
  3. svn repoからgit repoへfetchする 
    git svn fetch
  4. GitHubは1ファイル50MBで警告、100MBでブロックされる制限がある。gitはsvnと違い、部分チェックアウトできないのでバイナリファイルは削除して、軽量化したほうが良い。
  5. svnのブランチ/タグをgitへ変換したい場合
  6. remoteへpush 
    git remote add origin git@github.com:<user>/<repo>.git
git branch -M master
git push -u origin master
↑

GitHub pages: GitHub リポジトリでwebサイトを公開 †

↑

fork元リポジトリと同期 †

  1. upstream が登録されているか確認。ここではoriginしかかった 
    git remote -v

origin  git@github.com:<YOUR_USER>/<REPO>.git (fetch)
origin  git@github.com:<YOUR_USER>/<REPO>.git (push)
  2. fork元を upstream として登録 
    git remote add upstream https://github.com/<ORIGINAL_USER>/<REPO>.git
  3. upstreamを最新に更新 
    git fetch upstream
  4. 自分のリポジトリに変更を取り込む 
    git checkout master
git pull -p
git merge upstream/master
  5. 変更点を確認して、自分のリポジトリにpush 
    git diff origin/master
git push origin master
↑

act: GitHub Actionsをローカル実行 †

※GitHub actionsに「workflow_dispatch」が追加されたので、手動でのテストはできるようになった

↑

self-hosted runner: Actionsを実行する独自ホスト †

↑

private githubのReleasesからファイルをダウンロードする †

↑

Advanced search †

↑

リポジトリの移譲 †

↑

ガイドライン †

↑

ToC: 目次の自動生成 †

↑

Packages: パッケージの公開 †

↑

CLI: †

↑

Draft Pull Request †

PRを作る時に選択できるようになった。

  • 未完成でもPRを共有したい。
  • Draft PRはmergeボタンが無い。
  • 完成後、「Ready for review」ボタンで普通のPRに変更できる。

PRをDraftへ戻す。

↑

PR中にフィードバックを取り込む †

PRのレビュー中に、数行の変更を提案したい場合に便利。

↑

Organization: 企業や組織単位でリポジトリを管理 †

↑

Insights: リポジトリ/Organizationの分析/可視化 †

  • 分析/グラフの機能がある
    • Pulse:
      • 期間内で誰のコミットが多いか？
      • PR, Issueの数等
↑

README.md の書き方 †

↑

CHANGELOG.md の書き方 †

↑

project/スケジュール管理 †

↑

無料アカウントは1個人1つ †

GitHubの規約的には。

↑

複数アカウントのマージ †

↑

WebHook等で許可すべきIP †

IP制限をしている場合、GitHubのIPを許可する必要がある。

  • jsonで取得可能 
    curl -s https://api.github.com/meta | jq .
↑

Actions: ワークフローの自動化とカスタマイズ †

↑

GitHub markdownで使える言語 †

```言語の名前 or aliases
コード
```
↑

GitHub上で、ブランチ、コミットIDの比較 †

GitHub上で、ブランチ、コミットID間の比較ができる。
レビューする人の負担が減る。

GUIの場合:

  • 2019-06-27時点で、GUIからbranchは選択できる。tagは選択できないので、URL欄に直接入力。
  1. セレクトボックスから、デフォルト以外のbranchを選択
  2. Cloneボタンの下に、「Compare」リンクが表示されるのでクリック
  3. 比較したいbranchを選択

URLから直接入力する場合:

  • URL: 
    https://github.com/example/example/compare/<commit-id , branch , tag>...<commit-id , branch , tag>
  • 例1: stgディレクトリをコピーして、prodディレクトリを作成して変更。stgとprodの比較をしたい 
    # 作業用ブランチ作成
git co -b add/prod

# stgからprodへコピー
cp -R stg prod

# 重要。このcommit-idが比較元になる。例: 1234abc
git add prod
git commit

# prod/以下を変更してcommit
git commit

git push origin add/prod

# stgとprodの比較用リンクで確認し、PR等に記載
https://github.com/example/example/compare/1234abc...add/prod
↑

GitHubを使った開発フロー †

↑

Issue/PR Template †

↑

二段階認証 †

  • 二段階認証後
    • 初回(IPアドレス等？)ブラウザログイン時に、ワンタイムパスワードを入力する
    • clone時に、https://だとIDとアクセストークンをGitHub上で取得し、入力する必要がある。SSHの方が便利
↑

一時的にユーザ名の変更 †

  • コミット時に指定 
    git commit --author='User1 <user1@example.com>' -a
  • リポジトリ毎に指定( repository/.git/config) 
    git config user.name "user1"
git config user.email "user1@example.com"
↑

GitHub for WindowsでBitBucketを使う †

GitHubはデフォルトで正しい秘密鍵が指定されるようだが、BitBucketでは秘密鍵を明示的に指定する必要があった

  1. https://bitbucket.org/ のアカウントの管理 > SSHキーにGitHub for Windowsで使用している公開鍵を追加
    • %USERPROFILE%\.ssh\github_rsa.pub
  2. Git Shellを開き以下のようにする 
    vim ~/.ssh/config
----
Host bitbucket.org
  User git
  Port 22
  HostName bitbucket.org
  IdentityFile ~/.ssh/github_rsa
  TCPKeepAlive yes
  IdentitiesOnly yes
----
↑

GitHubに登録した公開鍵は世界に公開される †

  • 以下のアドレスから誰でも取得できる。未登録の場合は空
  • GitHubのアカウント名を知っていれば、ログインしたいホストの ~/.ssh/authorized_keys に追加すればOK
  • 公開鍵末尾のスペース以降はコメントなので、判別しやすいコメントを付けると良い 
    ssh-rsa AAAAB3N...YFd8w6Q== username@example.com
↑

よく使うリンク †

↑

Markdown記法 †

↑

webhook: push後、指定サーバに通知を送信、サーバ上で自動更新 †

↑

接続に使うユーザの確認 †

ssh -T git@github.com

Hi <UserName> ...
↑

ERROR: Repository not found. †

  • pull権限はあるが、push権限が無い場合もこのエラー
  • githubアカウントが複数あり、それぞれ異なるpublic keyがssh-addに登録されている場合も同じエラー 
    # 登録されている鍵を確認
ssh-add -l

# ユーザ名が正しいか確認
ssh -T git@github.com

# 間違っている場合。現在の設定を削除
ssh-add -D
↑

Issue †

  • Problem : 解決されるべき事
  • Issue : 議論されるべき事
  • コメントに #1 等のIssue番号を入れる事で自動的にリンクしてくれる。
  • #1 fixed, #1 closed等の決められた単語をコミットメッセージに入れる事で、Issueをcloseできる 
    git commi -m "#1 fixed"
git commi -m "#1 closed"
↑

githubのpull request †

変更点を含んだブランチを元リポジトリに取り込んで貰うようにリクエストを投げる事

  • 編集する人
    • コンソールでの作業 
      # 現在のbranch確認
git branch -a
* master

# 最新のmasterに更新
git pull

# 作業用ブランチ作成とチェックアウト
git checkout -b new-branch

# 現在のbranch確認
git branch
  master
* new-branch

# ファイルを変更、追加
# 変更点確認
git diff .

# 問題なければコミット
git commit .

# ブランチをリモートへプッシュ
git push origin new-branch
    • GitHub上での作業
  1. 該当ブランチを選択
  2. Compare & pull Request ボタン
  3. @名前で該当の人を記入
  • Pull requestを受け取った人
  1. Changesetで変更点を確認
  2. Merge pull request
  3. Confirm merge
  4. Delete branch
  • 最新のマスターを取得 
    git checkout master
git pull
↑

リポジトリ毎に別のgithubアカウントを使う †

  • KeePassXCを使う方法。
    • Memo/keepass#z84ad8c4 参照。sshの秘密鍵を登録する。ssh-agent連携機能を使うのが楽で、セキュリティ的にも良いと思う
    • 1DBに、1秘密鍵の方が楽。使わないDBはロックしておく。1DBに複数は登録できるが、github側でどのアカウントが使われるか不明になるため、エラーになった。
    • git clone直後にlocal userを設定しておく 
      # 登録済み秘密鍵の確認。一つだけにしておく。
ssh-add -l

# githubユーザの確認。ここで該当ユーザかを確認
ssh git@github.com

git clone git@github.com:<USER>/example.git
cd example/
git config --local user.name "acocunt B name"
git config --local user.email "account B email"

  • /ssh/.config で github.comに別名を付ける方法

    • リポジトリ毎に別のユーザ名を使用できる。例えばuser1。global user.name, user.emailが設定されていない場合、commit, push等が出来ない 
      git clone git@github.com:<USER>/example.git
cd example/

git config user.name "user1"
git config user.email "user1@example.com"
git config --list

# ssh秘密鍵を適当な場所に置く
vim ~/.ssh/github-user1_rsa
chmod 600 ~/.ssh/github-user1_rsa

# ssh configを変更し、適当なホスト名を付ける
vim ~/.ssh/config
----
Host github-user1
  User git
  Port 22
  HostName github.com
  IdentityFile ~/.ssh/github-user1_rsa
  TCPKeepAlive yes
  IdentitiesOnly yes
----

# 接続テスト: 詳細を知りたければ「-v」を付ける
ssh -T github-user1
Hi user1! ... # のようにgithubのuser nameが表示されれば成功

# リポジトリ中のアドレスを変更
vim .git/config
----
    url = git@github-user1:REPO/git-test.git
----
  • push前ならcommit済みのauthorを変更できる。 
    git commit --amend --author="user1 <user1@example.com>"
# 確認
git log
↑

使い方 †

  • README.mdのリアルタイムプレビュー
  1. https://github.com/signup/free 無料アカウントの作成
  2. Linux上での作業用にSSH公開鍵の登録。パスフレーズをありにすると毎回聞かれるので空でも良い 
    ssh-keygen -t rsa -C "your_email@youremail.com"

秘密鍵と公開鍵が出来るので保存しておく
~/.ssh/id_rsa
~/.ssh/id_rsa.pub

コミットログに表示される名前とメールアドレスを設定。~/.gitconfig に保存される
git config --global user.name "your_name"
git config --global user.email "your_email@youremail.com"
  3. githubにログインした状態で右上のAccount Settingsを選択し、SSH Keys > Add SSH Keyに「~/.ssh/id_rsa.pub」の内容をコピペ
  4. 右上のCreate New Repoで新しいリポジトリ(例：example)を作成
  5. ローカルに新規リポジトリを作成する場合 
    mkdir example
cd example
git init
touch README
git add README
git commit -m 'first commit'
# URLに'origin' という短い別名を付ける(必須ではない)
git remote add origin git@github.com:your_name/example.git
# git push git@github.com:your_name/example.git master:master と同じ
git push -u origin master
    • linux上でローカルリポジトリをもってくる場合 
      git clone git://github.com/your_name/example.git
cd example

# リモートの更新内容を反映
git pull

# ファイルの追加
git add README

# 全ての変更を追加
git add .

# 変更の確認
git status

# 差分の確認
git diff [ファイル名]

# 変更を元に戻す
git revert ファイル名

# 変更のコミット
git commit -a

# リモートリポジトリへ反映
git push
トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2020-11-10 (火) 14:12:22 (72d)