Git on ゲンゾウ用ポストイット

Github Actions入門その5-式と関数

Sun, 07 May 2023 08:10:25 +0900

はじめに

以下のエントリに引き続き、Github Actions を学習して学んだことをまとめて見ました。

今回は Github Actions の学習シリーズの第 5 弾として、ワークフローの YAML 設定ファイル内で使用可能な式について解説します。その後、式の種類や使い方について説明していきます。

式について

環境変数の設定や実行中のワークフローの状態を取得するために「式」を利用できます。

式を使うと、以下のようなことができます。

リテラルの結合
実行中の環境情報の取得 ( 実行者、仮想マシン、等 )
関数呼び出し ( 値の加工等 )

算術計算のために演算子を使うこともできます。

式は if キーワードと一緒に利用されることが多いです。プログラミング言語のように、 if で指定した式の値が true となったときに、該当のステップが実行されます。

「文字列」ではなく「式」であると Github Actions に認識させるためには、以下の構文を使います。

1

${{ <式> }}

if キーワードの値として式を使用した場合は、 ${{ ... }} の構文を指定しないこともあります。というのも、Github Actions は if: 以降に指定した記述を「式」として評価・処理するためです。 if: 以降の記述に関しては、冗長かもしれませんが ${{ ... }} の形式で記述しておくのが間違いないでしょうし、チームメンバにとってもわかりやすいでしょう。

ローカルPC内でGithub Actionsを実行する - 'nekos/act'

Tue, 02 May 2023 08:34:34 +0900

はじめに

Github Actions の設定ファイルを記述した後、正しく動作するかを確認するために毎回リモートリポジトリにプッシュするのが面倒だなと思ったので良い方法が無いかと調べてみました。すると、ローカルで Github Actions の実行が可能なツールが見つかったので、検証してみました。

検証環境

1
2
3
4
5


$ uname -moi
arm64 unknown Darwin

$ bash -version | head -n 1
GNU bash, version 5.2.15(1)-release (aarch64-apple-darwin22.1.0)

見つけたツール : `nektos/act`

利用するツールは以下になります。

GitHub - nektos/act: Run your GitHub Actions locally ?

概要を見る限りは自分の目的にフィットしています。

`nektos/act` ってどんなツール？

Github Actions をローカルで実行するためのツールとのことです。

このツールを導入するメリットは以下となります。

.github/workflows ディレクトリ配下に設定ファイルを作成、変更した後、 commit/push しなくてもテストできるため開発効率が上がる
Makefile でタスクを管理することもできますが、 .github/worflows とタスクが重複し DRY ではなくなります。ローカルで実行できれば Makefile が不要となります。
- (この点については、 Github Actions から make を呼ぶことで回避できると思いますが公式ページのメリットとして書かれていました )

`nektos/act` って何をしてくれるに？

act コマンドが提供されます。

Github Actions入門その4-環境変数/スクリプト/Artifactsを使う

Sun, 30 Apr 2023 08:23:33 +0900

はじめに

以下のエントリに引き続き、Github Actions を学習して学んだことをまとめて見ました。

このエントリでは、カスタマイズのテクニックについて触れていきます。変数の使用方法、スクリプトの実行方法、ジョブとジョブの間をつなぐための方法により、カスタマイズが可能です。

ワークフローの中で変数を使う

Github Actions では、ワークフローが実行されるたびに割り当てられるデフォルトの環境変数があります。デフォルトの環境変数だけで不十分であれば、独自に環境変数を追加することも可能です。ワークフローの YAML 設定ファイルに定義することでこれを実現できます。

サンプルコードを見ていきましょう。以下のサンプルコードでは、 POSTGRES_HOST と POSTGRES_PORT という 2 つの環境変数を作成しています。環境変数は node client.js の中で参照可能です( Github Actions のなかでは、 Node.js はデフォルトで利用可能みたいです )。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


---
name: use-environment-variables
run-name: use-environment-variables
on:
 - push
jobs:
 use-environment-variables:
 runs-on: ubuntu-22.04
 steps:
 - uses: actions/checkout@v3
 - run: node .github/scripts/use_environment_variables.js
 env:
 POSTGRES_HOST: postgres_host
 POSTGRES_PORT: 5432

呼び出している JavaScript のコードは以下のようになっています。

Github Actions入門その3-アクションを探す・使う・自作する

Thu, 27 Apr 2023 10:44:39 +0900

はじめに

前々回、前回と Github Actions に登場する用語の整理した後、実際の YAML 設定ファイルの各項目と用語の対応を見てきました。

アクション ( Action ) は１つ以上のステップで構成されたブロックです。

ワークフローは、１つ以上のジョブを持ち、ジョブは１つ以上のステップを持ちます。 ( 詳細は以下を参照 )

Github Actions 入門その 1 ( 概要と用語の整理 ) | ゲンゾウ用ポストイット

ステップは独自のシェルコマンドを記述しても良いのですが、アクションを指定できます。アクションは Github で公開されているものを指定したり、自作したものを利用することもできます。

今回はアクションの探し方、使い方、自作方法について紹介します。

概要

ワークフローの中で利用するアクションは以下のいずれかの方法で提供されます。

ワークフローが実行される Github リポジトリ内(当然、 git commit && git push されています)
Github の公開リポジトリ
Docker Hub 上の公開 Docker イメージ

公開されているアクションの探し方

Github コミュニティで作成されたアクションを探す場合は、 Github Marketplace というサイトを利用するのが良いでしょう。キーワード検索もできますし、カテゴリ分類されているので役割の観点から探すこともできます。

Github Marketplace で見つけたアクションを追加

実際に Github Marketplace から検索したアクションを使ってみましょう。

Github Actions入門その2-簡単なワークフローを作成してみる

Wed, 26 Apr 2023 06:29:46 +0900

はじめに

前回は Github Actions の概要と用語の整理をしました。

Github Actions 入門その 1-概要と用語の整理 | ゲンゾウ用ポストイット

Github 上で実行できるワークフローを構築するためのサービスです。 Github 上でのソースコードの変更をトリガーにして、自動的にビルドやテストなどのワークフローを実行できます。 Unbutu、Windows、macOS などの環境で実行でき、必要なリソースを設定することで、ビルドなどのタスクを実行できます。

今回は、サンプルコードを触って Github Actions を実際に操作してみます。

簡単なワークフローを作成してみる

Github Actions では、ワークフローの設定を YAML 形式で記述します。

それぞれのワークフローは YAML 形式のファイル 1 つで表現されます。その YAML をワークフローを実行させたい Github リポジトリの .github/workflows というディレクトリに配置します。

ワークフローは、トリガーとなるイベント ( 例えば git push ) が発生したタイミングで実行されます。

ここからは実際にワークフロー設定ファイルを見ていきます。

以下のようなワークフローを作成してみます。

プッシュのタイミングで実行される
Node.js のツールである bats をインストールする
bats -v コマンドを実行する

まずはローカルに Git ワークスペースを作成します。

1
2
3
4
5


$ mkdir learning-github-actions

$ cd learning-github-actions

$ git init

対応する Git リモートリポジトリを作成します。ここでは Github CLI ( gh コマンド) を使って作成しますが、もちろんブラウザ経由で作成しても構いません。

Github Actions入門その1-概要と用語の整理

Sat, 22 Apr 2023 08:29:00 +0900

はじめに

今の組織で CICD のプラットフォームとして Github Actions メインに切り替えています。

今後更にこの流れが進みそうなので Github Actions について一から学びなおしてみようと思いました。

Github Actions とは

Github が提供している CI ( continuous integration ) と CD ( continuous delivery ) を実現するためのプラットフォームです。

CI/CD パイプラインとは

CI とはビルド、テスト、静的解析などの開発パイプラインを示します。過去には各作業者の PC 内で実行していましたが、環境差異による実行結果の違いや実行忘れなどの問題があることから、現在のほぼすべての開発組織で導入されている仕組みです。

CD とは CI に加えてアプリケーションのデプロイの流れまでを含めた用語となっています。

Github Actions が実行されるタイミング ( イベント )

実行のトリガは「Git ブランチに対して push されたタイミング」「プルリクが作成されたタイミング」「プルリクが main ブランチにマージされたタイミング」など任意のタイミングが指定できます。

具体的な例として、「誰かが Github リポジトリに新しい Issue を作成したタイミングで、ラベルを付与する」ことができます。

実行環境

Linxu、Windows、macOS の仮想マシンが用意されています。

Github 上のマネージド環境だけでなく、オンプレ環境や他のクラウドを実行環境とすることもできます。

また、仮想マシンではなくコンテナ環境を利用することもできます。

概要

Github Actions の構成要素について、概要を掴んでおきます。

「ワークフロー」と呼ばれるものを設定します。ワークフローは Github リポジトリの中で何らかの「イベント」が発生 ( トリガー ) したときに実行されます。例えば「プルリクエストの作成」や「Issue の作成」といったイベントがあります。

Gitでいろいろな形式、方法でタグの一覧を出力する

Fri, 21 Apr 2023 08:10:07 +0900

はじめに

Git のローカルワークスペース内でタグの一覧を出力するいろいろな方法を紹介します。

検証環境

1
2


$ git version
git version 2.40.0

利用する Git リポジトリは新規に自作するのが面倒だったので、程よい数のタグを保有している適当なリポジトリを利用させていただきました。

GitHub - sstephenson/bats: Bash Automated Testing System

シンプルにタグを一覧出力

git clone したディレクトリ内でタグの一覧を出力する最もシンプルな方法は、 git tag コマンドを実行することです。

1
2
3
4
5
6


$ git tag
v0.1.0
v0.2.0
v0.3.0
v0.3.1
v0.4.0

⚠ 事前に以下のコマンドを実行し、ローカルのワークスペース内にリモートリポジトリ上にある最新のタグ情報を取得していることを確認しておきましょう。

1

$ git fetch --all --tags

コミットハッシュと一緒にタグを一覧出力

git show ref コマンドを使うことで、タグと一緒にコミットハッシュを一覧出力できます。 ( 正しくはコミットハッシュの一覧の後方にタグをつけて出力しているんですけどね )

1
2
3
4
5
6
7


$ git show-ref --tags -d

2f192ebffa8f8f8d1a5882e74188d6f67b295950 refs/tags/v0.1.0
5030f53eccc66ba9a041d1a4a28f73286de50449 refs/tags/v0.2.0
0e5e44572844ce8fd027d96a5001125c33abd822 refs/tags/v0.3.0
2e2477881bc52791f7bc0321599064b9daf7c6bf refs/tags/v0.3.1
7b032e4b232666ee24f150338bad73de65c7b99d refs/tags/v0.4.0

名前をパターン指定してタグを一覧出力

-l オプション(--list)を使って、指定されたパターンにマッチしたタグ名のものだけを一覧出力できます。

Gitで最新のタグを取得する方法

Fri, 21 Apr 2023 07:38:19 +0900

はじめに

Git のローカルワークスペース内で最新のタグを取得するコマンドを紹介します。

検証環境

1
2


$ git version
git version 2.40.0

`git describe --tags` コマンドを使う

結論からいうと、 git describe --tags コマンドを使うことで最新のタグを取得できます。

実際に試してみる

ローカルに Git のローカルワークスペースを作成し動作を確認してみます。

まずは git init でワークスペースを作成します。

1
2


$ git init
Initialized empty Git repository in /Users/genzouw/work/.git/

適当なファイル(ここではtest.txt)を作成し、内容を編集した後、コミットします。

それぞれのコミットタイミングでタグを付与しておきます。 ( それぞれ 1 、 2 、 2.1 というタグを付与 )

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


$ echo 1 >> test.txt
$ git add test.txt
$ git commit -m "commit 1"
$ git tag 1

$ echo 2 >> test.txt
$ git add test.txt
$ git commit -m "commit 2"
$ git tag 2 -m "Tag 2"

$ echo 3 >> test.txt
$ git add test.txt
$ git commit -m "commit 3"
$ git tag 2.1

git log で確認してみると、3 つのコミットとともにタグが付与されていることがわかります。

Semantic Versioning形式のGitタグをインクリメントしてpushするスクリプト

Mon, 13 Feb 2023 10:07:24 +0900

はじめに

先日ネット上で見つけたエントリを見て書こうと思ったエントリです。

Git のタグとして Semantic Versioning 形式を採用している事例でした。そのエントリでは、パッチバージョン ( vXXX.YYY.ZZZ の ZZZ 部分 ) をインクリメントするのが面倒なのでスクリプト化してみたと書かれていました。

それをみて、僕も同じようにスクリプト化してみました。

検証環境

1
2
3
4
5


$ uname -moi
arm64 unknown Darwin

$ bash -version | head -n 1
GNU bash, バージョン 5.2.15(1)-release (aarch64-apple-darwin22.1.0)

前提

前提として、バージョニングのフォーマットは vXXX.YYY.ZZZ としました。

タグの先頭に固定の文字として v という文字列を付与しています。

その後に数値が続き、 メジャーパージョン + . + マイナーバージョン + . + パッチバージョン の形式で続くものとしました。

ただし、 v を不要にしたり、ドットを 4 つにしたりは容易にできる作りとなっています。

スクリプト

スクリプト名は何でも良いですが、 git-tag-inc として保存しました。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


#!/usr/bin/env bash
set -o errexit
set -o nounset
set -o noclobber

declare TAG_FORMAT='v[0-9]+.[0-9]+.[0-9]+'

echo "[CAUTION] The tag format is '${TAG_FORMAT}'." >&2

IFS=. read -r MAJOR MINOR PATCH < <(
 git tag \
 | grep -E "${TAG_FORMAT}" \
 | sort -t "." -k1,1n -k2,2n -k3,3n \
 | sed -n '$s/^v//p'
) || true

TAG="v${MAJOR:-1}.${MINOR:-0}.$((${PATCH:- -1} + 1))"

git tag "${TAG}" \
 && echo "${TAG}" >&2

git push --tags

使い方

Git のローカルワークスペースで、 git-tag-inc コマンドを実行してください。

Gitリポジトリに誤ってAWSアクセスキーなどをコミットしないようにgit-secretsを導入

Wed, 01 Feb 2023 11:43:51 +0900

はじめに

サービスの事項環境として AWS を利用していた場合に特に気をつけなければ行けないのが、AWS のアクセスキーのような「API キー」の類をコミットしてしまうことです。

コードに記述しないように気をつけていたとしても、ひょんな事でコミットしてしまうことがあります。

このようなミスに気付けるように git-secrets を導入してみましょう。

検証環境

1
2
3
4
5


$ uname -moi
arm64 unknown Darwin

$ bash -version | head -n 1
GNU bash, バージョン 5.2.15(1)-release (aarch64-apple-darwin22.1.0)

git-secrets とは

git-secrets は、「API キー」だけでなく、パスワードやその他のセンシティブ情報のコミットを防ぐためのツールです。

GitHub - awslabs/git-secrets: Prevents you from committing secrets and credentials into git repositories

Git リポジトリに秘匿情報が含まれないように、次のものを監視します。

コミット
コミットメッセージ
--no-ff マージ

上記のいずれかに秘匿情報が含まれていた場合には、コミットが拒否されるようにできます。

git commit のタイミングでチェックが実行されるということです 。

インストール

PATH 環境変数に設定されているいずれかのディレクトリ ( echo "$PATH" | sed 's/:/\n/g' で確認できる ) に配置しておきましょう。

Gitの作業ディレクトリからコマンドでデフォルトブランチ名を取得する

Sat, 06 Aug 2022 08:00:46 +0900

はじめに

git clone した作業ディレクトリで作業中しているとき、デフォルトブランチに切り替えたいのですが、デフォルトブランチ名を取得する方法がわかりませんでした。

以前は master ブランチをデフォルトブランチとしているケースがほとんどでしたが、最近では main ブランチや中には develop ブランチをデフォルトブランチに設定しているリポジトリにも出会うようになりました。

なんとか取得できないかと調べて、取得する方法が見つかったのでメモを残しておきます。

検証環境

1
2
3
4
5
6
7
8


$ uname -moi
arm64 unknown Darwin

$ bash -version | head -n 1
GNU bash, バージョン 5.1.16(1)-release (aarch64-apple-darwin21.1.0)

$ git --version
git version 2.37.1

GitHub CLI を使う

GitHub を使っていることが前提となりますが、 Git の作業ディレクトリに対応するリモートリポジトリからデフォルトブランチ名を取得します。

GitHub リポジトリの情報にアクセスするため GitHub CLI を使います。

GitHub CLI については、インストール方法や使い方を過去のエントリで紹介しています。

GitHub CLI を使ってコマンドラインからイシュー、プルリクを検索、表示してみる | ゲンゾウ用ポストイット

GitHub CLI でインストールされた gh コマンドを使えば、作業ディレクトリに対応する GitHub 上のリポジトリの設定情報を取得する事ができます。

Gitでローカルブランチ、リモートブランチの名前を変更(リネーム)する方法

Tue, 19 Jul 2022 17:12:40 +0900

はじめに

今更のエントリではありますが、Git でブランチ名を変更する方法を毎回忘れてわざわざ以下のステップを実行しているのでいいかげん整理しておこうと思いました。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


# 間違ったブランチ ブランチが現在のブランチ
$ git branch
 main
* 間違ったブランチ

# 正しいブランチ ブランチを新規作成
$ git checkout -b 正しいブランチ
Switched to a new branch '正しいブランチ'


# 正しいブランチ ブランチが現在のブランチ
$ git branch
 main
* 正しいブランチ
 間違ったブランチ

# 間違ったブランチ ブランチは不要なため削除
$ git branch -d 間違ったブランチ
Deleted branch 間違ったブランチ (was 3c3b0a1).

# ブランチを確認
$ git branch
 main
* 正しいブランチ

この方法でブランチはリネーム出来ますが、面倒であることや git push しリモートブランチとして反映されてしまった場合に対応でき ません。

Gitに大容量ファイルをプッシュするときには"Git LFS"を利用しよう

Wed, 09 Feb 2022 11:21:50 +0900

はじめに

Git の利用目的として、「ソースコード」の配置だけでなく、「テストデータ」や画像や音声、動画といった「メディアファイル」の配置にも使われるようになってきている。

ところが、 Git は大容量のファイルをうまく処理できず、リポジトリがすぐに肥大化してしまう。

そこで登場したのが Git LFS という機能です。

今回は Git LFS のメリットや、

検証環境

1
2
3
4
5


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, バージョン 5.1.16(1)-release (x86_64-apple-darwin21.1.0)

“Git LFS” がない時

もともとソースコード用に最適化されていた。テキストファイルですので、マージしたり、圧縮することで容量を劇的に小さくできます。

ところが、大きなバイナリファイルを履歴管理したり、圧縮したりするととたんに非効率となり、速度も劣化しました。特にバイナリファイルは圧縮率が低く（画像や動画はもともと圧縮済みということもあり）ほぼそのままのサイズで履歴保存されてしまいます。

10MB のファイルを 10 回コミットすれば履歴はあっという間に 100MB、100 回コミットすれば 1GB となってしまいます。

“Git LFS” がある時

この問題に対して、 “Git LFS” では大容量のファイル（主にバイナリファイルとなる）を Git の外部にあるストレージ ( LFS = Large File Storage )に保存するという方法を取ります。

バイナリファイルの実体（実ファイル）は外部ストレージに保存し、これに対する「参照（リンク）」だけを Git で履歴として保存、操作します。

direnvと環境変数を使ってGitのユーザ名、メールアドレス、SSH KEYをリポジトリ毎に切り替える

Wed, 04 Aug 2021 15:30:26 +0900

はじめに

Github を使って複数のプロジェクトを兼任していると、Git の複数アカウントを切り替えて使う必要がある場合があります。

僕は諸事情により Github アカウントを仕事用 x2、個人用 x1 を所有しています。

よく知られている方法としては、以下のように git config --local コマンドで切り替えるやり方があります。

1
2
3


$ git config --local user.name "アカウント"
$ git config --local user.email "メールアドレス"
$ git config --local core.sshCommand="ssh -i ~/.ssh/ANOTHER_ID_RSA"

こういったマルチアカウント利用ケースにて、環境変数を使って Git の ユーザ名(username) 、 e-mail(email) 、 SSH KEY の切り替え作業を効率化するための方法について紹介します。

検証環境

1
2
3
4
5
6
7
8


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, version 5.1.8(1)-release (x86_64-apple-darwin20.3.0)

$ git --version
git version 2.32.0

前提条件（必要なツール）

今回は direnv というツールを利用することを前提としています。

"git prune"コマンドが何をしてくれるものなのかを操作しながら理解する

Wed, 21 Jul 2021 09:33:34 +0900

はじめに

git prune コマンドは掃除用の Git サブコマンドです。

Git のコミット履歴の実体はハッシュ値を一意キーとする “Git オブジェクト” の集合体です。 Git オブジェクトのうち、到達不能(不要)になったものを掃除するために使用するのが git prune コマンドです。

ブランチ名やタグ名を起点として、コミットツリーからたどることができなくなった要素を 到達不能となった Git オブジェクト と呼びます。

git pruneは基本的に直接実行しません。

「ゴミ掃除コマンド」であり、git gc コマンドの 子コマンド ( git gc コマンドの中で実行されるコマング群の 1 つ ) です。

検証環境

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


$ uname -moi
x86_64 x86_64 GNU/Linux

$ head -n 2 /etc/os-release
PRETTY_NAME="Ubuntu Impish Indri (development branch)"
NAME="Ubuntu"

$ bash -version | head -n 1
GNU bash, version 5.1.8(1)-release (x86_64-pc-linux-gnu)

$ git --version | head -n 1
git version 2.31.1

`git prune` コマンドの「お掃除機能」について

git pruneコマンドが実行されたときにどんなことが起きるかを理解するために、実際に到達不能なコミットを作った後、実行してみましょう。

Git でやってしまった！そんなときに変更を取り消す便利なツール "git-branchless"

Thu, 01 Jul 2021 17:29:45 +0900

はじめに

Git で誤って git reset 、 git rebase をしてしまって冷や汗が出たことがある方は少なくないはずです。

僕も何度自分のローカルブランチでやってしまったことか。

焦りながらも git reflog で最後の変更を見つけ出し、なんとかもとに戻せた！

という場合もあれば、

うまく戻せずに結局最初から開発やり直し…

となったこともあります。

git reflog の操作が難しいですよね。

変更がもっとかんたんにもとに戻せたら、と常々思っていましたが、そんな問題にぴったりのツールを見つけました。

検証環境

1
2
3
4
5
6
7
8


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ zsh --version | head -n 1
zsh 5.8 (x86_64-apple-darwin19.6.0)

$ git version
git version 2.32.0

git-branchless

見つけたのは arxanas/git-branchless というツールになります。

git-branchless はツールのセットになります。コミット履歴を 視覚化 、 ナビゲーション 、 操作の支援 、修復するのを手助けしてくれます。

“Google” や “Facebook” といった大企業で利用されている branchless Mercurial worlflows と呼ばれる開発フロー（？）に基づいているそうです。

"git diff"コマンドの実行結果をGithub風に表示できる"git-split-diffs"

Mon, 24 May 2021 10:49:32 +0900

はじめに

git diff コマンドの実行結果を Github の diff 表示のようなスタイルに変更できる 「git-split-diffs」 というツールを見つけたので紹介します。

検証環境

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, version 5.1.8(1)-release (x86_64-apple-darwin20.3.0)

$ node --version
v15.12.0

$ yarn --version
1.22.10

git-split-diffs とはなに？

ターミナル上で git diff したときに、実行結果を Github 風に表示してくれるツールです。

はじめはターミナル上で実行するのに Github 風にとは一体？と思いましたが、実際に使ってみたいと思います。

前提環境

node 1.12 以上がインストールされている必要があります。

Gitリポジトリ作成時のデフォルトブランチ名がmainとなるように設定する

Sun, 23 May 2021 08:27:07 +0900

はじめに

こちらもいずれやらないとなぁと思ったままお座なりになっていたローカル環境の設定です。

「シェルで Github リポジトリの master ブランチの名前を main ブランチに変更する」というエントリでもお話しましたが、 Github リポジトリを新規に作成した場合のデフォルトブランチ名が master から main に変更となっています。（もう随分前の話ですね。）

そんな時代の流れとは裏腹に、自分の PC で git init し Git リポジトリを新規作成した際のデフォルトブランチ名が未だに master となっています。

少しでもおっさん化の流れに抵抗する必要があるということで、 git init したときに作られるデフォルトブランチ名を main にするための設定をしようと思いました。

検証環境

1
2
3
4
5
6
7
8


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, version 5.1.8(1)-release (x86_64-apple-darwin20.3.0)

$ git --version
git version 2.31.1

今回の作業の前提

当然のことながら git コマンドが使えるようになっている必要があります。

加えて、 Git のバージョンが 2.28 以降でなければいけません。

シェルでGithubリポジトリのmasterブランチの名前をmainブランチに変更する

Sat, 22 May 2021 09:02:13 +0900

はじめに

随分前のことですが、新規に作成される Github リポジトリのデフォルトブランチ名が master から main に変更となりました。

ところが既存の Github リポジトリは当然 master というブランチ名のままです。

機会があれば昨今の風潮にのって一括修正しようかなぁ、と思っていましたが、ブログネタについでにシェルでブランチ名の変更を行ってみました。

大量に Github リポジトリを持っている組織などでも利用できるのではないでしょうか。

検証環境

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, version 5.1.8(1)-release (x86_64-apple-darwin20.3.0)

$ git --version
git version 2.31.1

$ gh --version
gh version 1.10.2 (2021-05-19)
https://github.com/cli/cli/releases/tag/v1.10.2

今回利用するツール

今回は以下のツールを利用します。

GitHub CLIでIssue(イシュー)やPull-Request(プルリクエスト)にコメントがつけられるようになりました。

Fri, 29 Jan 2021 19:26:36 +0900

はじめに

GitHubに対する操作をコマンドラインから実行するためのコマンドとして、 GitHub CLI を愛用しています。

昔は hub コマンドを使っていましたが、 GitHub CLI がリリースされてからはこちらを使っています。

つい先日、GitHub CLIでIssue(イシュー)やプルリクエストにコメントがつけられるようになりました。

早速使ってみたいと思います。

検証環境

1
2
3
4
5
6
7
8
9


$ uname -moi
x86_64 MacBookPro16,1 Darwin

$ bash -version | head -n 1
GNU bash, version 5.0.18(1)-release (x86_64-apple-darwin19.5.0)

$ brew --version
Homebrew 2.7.7-32-gebcd56c
Homebrew/homebrew-core (git revision ce8c6c; last commit 2021-01-29)

Github CLIのインストール or アップグレード

まだインストールされていない場合

インストールされていない場合には、以下のコマンドを実行します。

1

$ brew install gh

すでにインストールされている場合

インストール済みでバージョンが古い場合はアップグレードしましょう。

バージョンを確認してみます。

1
2
3


$ gh --version
gh version 1.3.1 (2020-12-03)
https://github.com/cli/cli/releases/latest

最新版は 1.5 であり、このバージョンでないとIssueやPull Requestにコメントを付けられない。そこでアップグレードを行います。

Gitでmasterブランチにマージ済みのローカルブランチを一括削除する

Thu, 19 Nov 2020 08:30:07 +0900

はじめに

Gitでは容易にブランチを作成し、切り替えることができます。ただ、容易にブランチを作成できるがゆえに、不要なブランチがわかりにくく、残ってしまうことがあります。

すでにmasterブランチにマージされているが、ローカルに残ってしまったブランチ を掃除するためのコマンドを紹介します。

※実行前には、実行結果を確認してください！自己責任でお願いします！

検証環境

1
2
3
4
5
6
7
8


$ uname -moi
x86_64 x86_64 GNU/Linux

$ bash -version | head -n 1
GNU bash, version 4.2.46(2)-release (x86_64-redhat-linux-gnu)

$ git --version
git version 1.8.3.1

masterブランチマージ済みのローカルブランチを削除

まずはローカルブランチを対象とした掃除の方法について。

git branch --merged master コマンドでmasterブランチにマージ済みのローカルブランチを出力できます。ここから カレントブランチ 、 masterブランチ 、 developブランチ を除外します。

最後に該当のブランチ名を git branch -d で1つずつ削除していきます。

1
2
3
4


git branch --merged master \
 | sed -n 's@^\s*@@p' \
 | grep -v -e '^\*' -e '^\(master\|develop\)$' \
 | xargs -n 1 git branch -d

masterブランチマージ済みのoriginリモートブランチを削除

すでにpush済みのリモートブランチを対象とした掃除の方法について。

シェルを使って、Gitワークスペース内でリモートリポジトリのURLのみを抽出する

Mon, 25 May 2020 14:16:47 +0900

はじめに

github.com上のソースコードに対して何らかの作業を実施する際には、まず git clone を行います。 git clone したGitワークスペース上でソースを閲覧したりコードを改変します。この時点で、 origin リモートリポジトリにプッシュ先のURL情報などが格納されます。

今回、このGitワークスペースと紐付けられている origin リモートリポジトリのURL部分を抽出したいと思いました。

抽出する方法について紹介します。

検証環境

1
2
3
4
5


$ uname -moi
x86_64 MacBookPro11,4 Darwin

$ bash -version | head -n 1
GNU bash, バージョン 5.0.17(1)-release (x86_64-apple-darwin18.7.0)

リモートリポジトリの情報をURL部分も含め出力

リモートリポジトリの情報を一式表示するには以下のコマンドを利用します。

1
2
3
4
5


$ git remote -v
origin git@github.com:genzouw/ec-cube.git (fetch)
origin git@github.com:genzouw/ec-cube.git (push)
upstream git@github.com:EC-CUBE/ec-cube.git (fetch)
upstream git@github.com:EC-CUBE/ec-cube.git (push)

ここでは、 origin リモートリポジトリに加えて、 upstream リモートリポジトリも紐付けられていることがわかります。

また、URL部分以外も出力されているため、 **URLだけが欲しい場合は余分を除去する必要があります。

また、便利なコマンドではありますがリモートリポジトリへの通信が発生します。

リモートリポジトリのURL部分のみを出力

URL部分だけが欲しい場合には以下のコマンドが利用できます。

1
2
3


# originリモートリポジトリのURLを出力
$ git remote get-url origin
git@github.com:genzouw/ec-cube.git

以下のコマンドでも同様の結果が取得できます。

既存のすべてのBitbucketリポジトリをGithubに移行するためのシェルコマンド

Sun, 08 Dec 2019 22:57:19 +0900

はじめに

GitHub で無制限にプライベートリポジトリを作成できるようになったため、今まで Bitbucket で管理していた自分のリポジトリを Github に移行しました。

大したコマンドではないのですが、移行のために実行したコマンドを共有します。

検証環境

1
2
3
4
5
6
7
8
9


$ uname -moi
x86_64 MacBookPro10,1 Darwin

$ bash -version | head -n 1
GNU bash, バージョン 5.0.11(1)-release (x86_64-apple-darwin18.6.0)

$ hub --version
git version 2.24.0
hub version 2.13.0

前提条件

コマンドラインから Github を操作するためのコマンドである github/hub がインストールされていることが前提となります。

hub コマンドについては以前、別のエントリで紹介しています。よかったらご参考ください。
- コマンドラインから”Docker Hub”からDockerイメージを検索し詳細ページを開く | ゲンゾウ用ポストイット

実行コマンド

以下のコマンドを、 git clone した作業ディレクトリが配置されているディレクトリ配下で実行します。 .git ディレクトリを探し出し、自動的に Github 上にリポジトリを作成していきます。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


$ find . -type d -name .git \
 | while read GIT_DIR; do

 # .gitディレクトリが置かれているディレクトリに移動
 cd "$(dirname "${GIT_DIR}")"

 # 設定済みのリモートブランチを一度削除
 git remote rm origin

 # github上にプライベートリポジトリを作成
 hub create -p

 # 早すぎると作成したばかりのgithubリポジトリにpushできないことがあるので気持ち待つ
 sleep 3

 # push
 git push -u
 done

ひとこと

このあと、 ghq コマンドを使ってすべてのリポジトリを取得してきましたがまた機会を見てそのコマンドも掲載します。

Github上のOSSにプルリクエストをあげるための手順をまとめました

Wed, 08 May 2019 23:38:20 +0900

はじめに

以下のOSSに対して、プルリクエストを上げたいと思ったのですが、「この作業以前もやっていたよな？」と思いました。いい機会なのでプルリクエストの上げ方を整理してみました。

GitHub - simonwhitaker/gibo: Easy access to gitignore boilerplates

手順

1. リポジトリをForkします

ターゲットとなるリポジトリのトップページを開き、ページ右上の 「Fork」 のボタンを押します。

以下のようなダイアログが表示された場合はフォーク後のリポジトリの所有者となる「ユーザ」 or 「チーム」を選択してください。

Forkが始まったらしばし待ちましょう。

Forkが完了すれば、以下のようなページが表示されるはずです。（リポジトリ名のスラッシュの前、所有者名が genzouw という僕のアカウント名に変わっていますね。）

2. リポジトリをクローンします

ここからはブラウザ上の操作から変わって、コンソールの作業となります。

git コマンドを使ってプロジェクトをクローンします。

リポジトリのURLは、先程の「Fork済みリポジトリページ」の右上にある「Clone or download」というボタンからクリップボードにコピーできます。

今回のリポジトリは以下のようなURLになりました。

1

git@github.com:genzouw/gibo.git

git コマンドでクローンし、フォルダに移動します。

1
2


$ git clone git@github.com:genzouw/gibo.git \
 && cd gibo

3. 「変更内容をコミットするためのブランチ」を作成します

「変更内容をコミットするためのブランチ」を作成します。

今回は「GitFlow」を参考に feature/find_files_in_subdirectories というブランチ名にしています。 find_files_in_subdirectories の部分には改修内容がわかるようにスネークケースで名前をつけています。

1

$ git checkout -b feature/find_files_in_subdirectories

4. ファイルの編集・追加を行う

適宜変更しましょう。省略します。

プロジェクトに最適な .gitignore をコマンドラインから簡単に生成するためのツール「gibo」

Wed, 27 Mar 2019 14:00:05 +0900

はじめに

プロジェクトに最適な.gitignore をどうやって作ろうかなと思っていたところ、 gibo という便利ツールを発見したのでメモ。

gibo は、プロジェクトに最適な .gitignore ファイルを作成してくれるツールです。様々な言語、フレームワーク、ツールに対応していて、大抵のメジャーなものについては、簡単に .gitignore を生成できます。

ソースコードを読んでみましたが、簡潔で見やすく、シェルスクリプトの勉強に良いと感じました。

検証環境

1
2
3
4
5


$ uname -moi
x86_64 MacBookPro11,4 Darwin

$ bash -version
GNU bash, バージョン 5.0.3(1)-release (x86_64-apple-darwin18.2.0)

インストール

プラットフォームことに最適なインストール方法が異なりますが、実際 1 ファイルのシェルスクリプトなのでダウンロードしてきて $PATH 環境変数の通っているディレクトリに配置すれば動作します。

macOS

Homebrew で一発でインストールできます。

1
2


$ brew install gibo \
 && gibo update

Unix 系 OS

1
2


$ curl -L https://raw.github.com/simonwhitaker/gibo/master/gibo \
 -so ~/bin/gibo && chmod +x ~/bin/gibo && gibo update

動作確認

インストールができたか確認してみましょう。

シェルスクリプトで任意のオーナーが所有するGithubリポジトリを一覧表示する（ワンライナー）

Wed, 20 Mar 2019 07:59:15 +0900

はじめに

Githubで任意のオーナーが所有するリポジトリを全て確認したいのですが、Githubのリポジトリ一覧ページに到達するまで面倒ですよね。（僕がGithub不慣れなだけなのでしょうか？ )

そこで、シェルスクリプト化していつでも一覧を表示できるようにしてみました。

スクリプト

`hub-repos.sh`

1
2
3
4
5


#!/usr/bin/env bash
set -o nounset
set -o noclobber

curl "https://api.github.com/users/${1:-${SNS_USERNAME}}/repos?per_page=100" 2>/dev/null | jq -r '.[].name'

必要なもの

jq コマンドが使えること

使い方

以下のいずれかで所有者を設定できます。

環境変数 SNS_USERNAME を設定する。 ( ex : export SNS_USERNAME=genzouw )
スクリプトの第一引数を指定する ( ex : hub-repos.sh genzouw )

パスの通っている場所に配置してあげてください。

ひとこと

ずいぶん昔に作ったスクリプトの整理をしていて見つけました。当時のスクリプトは、 jq を使っている部分に ruby -rjson -e 'JSON.parse(STDIN.read).each{|r|puts r["name"]}' と記述されていました。 ruby触っていた記憶なんてほとんど無いんですけどね。

コマンドラインからBitbucketのリポジトリを操作するためのツール「bitbucket-cli」でリポジトリを作成してみる

Fri, 08 Mar 2019 08:44:02 +0900

はじめに

会社で利用しているGitのホスティングサービスは Bitbucket logo ですが、コマンドラインからリポジトリ作成やプルリクエストを投げられると便利です。

自分のPCに導入している bitbucket-cli を紹介します。

※ちなみにGithub用のコマンドラインツールは Githubの無料アカウントユーザにもPrivateリポジトリ作成が無制限になったのでコマンド一発でどんどん作成するための環境を作ってみるを参照ください。

検証環境

1
2
3
4
5
6
7
8


$ uname -a
Linux 8f10b748d929 4.9.125-linuxkit #1 SMP Fri Sep 7 08:20:28 UTC 2018 x86_64 x86_64 x86_64 GNU/Linux

$ bash -version
GNU bash, version 4.2.46(2)-release (x86_64-redhat-linux-gnu)

$ python --version
Python 2.7.5

必要なもの

Python（2.7.9以上のバージョン）

インストール

pip のインストール

Pythonで動作するツールということで、 pip のインストールが必要。

以下のコマンドを実行し、バージョンが表示されていればすでにインストール済みなので、 pip のセットアップは不要。

1
2


$ pip --version
pip 19.0.3 from /usr/lib/python2.7/site-packages/pip (python 2.7)

インストールは簡単。

Bitbucket上で個人、あるいは組織で所有するリポジトリを一覧表示するためのシェルスクリプト

Thu, 24 Jan 2019 08:18:19 +0900

Bitbucket上で個人、あるいは組織で所有するリポジトリを一覧表示するためのシェルスクリプト

背景

仕事で自分の組織が所有するBitbucketのリポジトリを全て取得し、grep検索したい場合がありましたが、BitbucketのWebページの一覧性はよくありません。（特にページングされているので、全てを一覧表示できない。）

また、Vimで編集しやすいように、 コマンドラインから一覧表示するためのシェルスクリプト を作成しました。

検証環境

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


$ uname -a
Darwin NP178 18.2.0 Darwin Kernel Version 18.2.0: Mon Nov 12 20:24:46 PST 2018; root:xnu-4903.231.4~2/RELEASE_X86_64 x86_64 i386 MacBookPro11,4 Darwin


$ bash -version
GNU bash, バージョン 5.0.2(1)-release (x86_64-apple-darwin18.2.0)
Copyright (C) 2019 Free Software Foundation, Inc.
ライセンス GPLv3+: GNU GPL バージョン 3 またはそれ以降 <http://gnu.org/licenses/gpl.html>

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.


$ zsh --version
zsh 5.6.2 (x86_64-apple-darwin17.7.0)

前提条件

jqという、jsonデータを操作するためのツール

スクリプト

show-bitbucket-repositories.sh

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48


#!/usr/bin/env bash
set -o errexit # エラーが発生した場合はシェルを終了
set -o nounset # 未定義の変数を利用禁止

opts='hu:p:o:'

usage() {
 echo -n "${0}"
 echo "${opts}" | sed 's/\([a-z]\)/ -\1/g' | sed 's/\-\([a-z]\):/-\1 \U\1\E/g'
 exit 1
}

type jq >/dev/null 2>&1 || {
 echo 'jqコマンドがありません。停止します。'
 exit 101
}

while getopts ":${opts}" opt; do
 case "${opt}" in
 u)
 BITBUCKET_USER=${OPTARG}
 ;;
 p)
 BITBUCKET_PASSWORD="${OPTARG}"
 ;;
 o)
 BITBUCKET_ORG="${OPTARG}"
 ;;
 h | : | \?)
 usage
 exit 0
 ;;
 esac
done

API_URL="https://api.bitbucket.org/2.0/repositories/${BITBUCKET_ORG:-${BITBUCKET_USER}}"

while [[ $API_URL != "null" ]]; do
 tmp=$(mktemp)

 curl \
 --silent \
 --user "$BITBUCKET_USER:$BITBUCKET_PASSWORD" "${API_URL}" >"${tmp}"

 # API実行結果がページングされて返却されるため、次ページ情報が存在するかを確認（ない場合にはnullという値が取得される）
 API_URL="$(cat "${tmp}" | jq -r .next)"
 cat "${tmp}" | jq -r -c ".values[].links.clone[].href" | grep 'https://'
done

設置方法

環境変数 $PATH が設定されているディレクトリにファイルを配置してください。
- ex) ~/bin

1
2
3


$ vi show-bitbucket-repositories.sh

$ chmod 700 show-bitbucket-repositories.sh

実行方法

-u : ユーザID ( 必須 )
-p : パスワード ( 必須 )
-o : 組織情報 ( 任意：後述 )

1
2
3
4
5


# 個人のリポジトリ
$ ./show-bitbucket-repositories.sh -u genzouw -p password-dayo

# `-o` オプション付きで、組織で所有するものの一覧表示が可能
$ ./show-bitbucket-repositories.sh -u genzouw -p password-dayo -o my_organize

ちなみに

こちらのpythonのツールでも同じようなことはできます。

Githubで無料アカウントでもPrivateリポジトリ作成が無制限になったのでコマンドで操作するための環境を整える

Tue, 22 Jan 2019 08:54:12 +0900

はじめに

Githubの無料アカウントユーザにもPrivateリポジトリ作成が無制限となりましたね。

GitHub now gives free users unlimited private repositories

今まで Bitbucket を利用し横目で Githubユーザいいなぁ と思っていたが、Githubどんどん使っていこうかなと思った次第です。
とはいえ、今まで使っていた bitbucket-cli の bb コマンドのように、CUIで リポジトリを作成し たり プルリクエストあげ たり 削除し たりはできるようにしたいです。

以下のツールを導入してみます。

GitHub - github/hub: hub helps you win at git.

特徴

一部抜粋

hub is a command line tool that wraps git in order to extend it with extra features and commands that make working with GitHub easier.

日本語訳すると以下のようになります。

hubはGitHubでの作業を容易にする追加機能やコマンドでgitを拡張するためにgitをラップするコマンドラインツールです。

ラッパーツールということで Git は必須。

環境

1
2
3
4
5


$ uname -moi
x86_64 MacBookPro10,1 Darwin

$ zsh --version
zsh 5.6.2 (x86_64-apple-darwin17.7.0)

インストール

以下を参照

Macでgit-svnを使ってプロジェクトドキュメントをダウンロードするとファイルが管理対象外として扱われる

Wed, 16 Oct 2013 23:13:39 +0900

Macでgit-svnを使ってプロジェクトドキュメントをダウンロードするとダウンロードされたファイルが管理対象外として扱われる事象 Macでプロジェクトドキュメントを以下のコマンドでcloneした。 git clone -s http://hoge-server/path/to/the/project/ clone下ばかりのクリーンなフォルダのはずなのに、何故か日本語ディレクトリの幾つかが管理対象外扱いとなっている。どうも濁点、半濁点を含む日本語名フォルダがおかしくなる模様。対処法どうもMacは一般的なUTF-8とは異なる文字コードを利用しているようだ。簡単に説明すると、ファイル名…

日本語ファイル名をgit statusなどで文字化けさせずに表示する方法

Thu, 18 Nov 2010 14:46:05 +0900

会社のCygwin + Git環境だと、半角のみのファイルに関しては問題はないのだが、全角を含むファイル名を管理している場合に以下のコマンドで文字化けする。

1
2


$ git status
> create mode 100644 "\345\217\226\346\211\261\350\252\254\346\230\216\346\233\270.txt"

解決方法がようやくわかった。

git config –global core.quotepath false

http://tobysoft.net/wiki/index.php?git%2F%C6%FC%CB%DC%B8%EC%A5%D5%A5%A1%A5%A4%A5%EB%CC%BE%A4%F2git%20status%A4%CA%A4%C9%A4%C7%C9%BD%BC%A8%A4%B9%A4%EB%CA%FD%CB%A1

Cygwin環境では必須ですね。

git diffで文字化けが発生する場合の対処法

Sat, 07 Aug 2010 22:46:48 +0900

職場のWindowsにCygwinをインストールして作業している。以下のコマンドを実行すると文字化けしてしまう問題に遭遇。

1

git diff .

diffが文字化けすると日本語のコメント部分が読めなかったり、Markdownのドキュメントの変更点が追えず不便。

Gitに対して、以下の設定を行うことで文字化け対処できた。

1

git config --global core.pager 'lv -c'

lvをページャーに指定するだけだと文字化け解決できなかったので -c オプションを追加した。

Git on ゲンゾウ用ポストイット

Github Actions入門その5-式と関数

はじめに

式について

ローカルPC内でGithub Actionsを実行する - 'nekos/act'

はじめに

検証環境

見つけたツール : nektos/act

nektos/act ってどんなツール？

nektos/act って何をしてくれるに？

Github Actions入門その4-環境変数/スクリプト/Artifactsを使う

はじめに

ワークフローの中で変数を使う

Github Actions入門その3-アクションを探す・使う・自作する

はじめに

概要

公開されているアクションの探し方

Github Marketplace で見つけたアクションを追加

Github Actions入門その2-簡単なワークフローを作成してみる

はじめに

簡単なワークフローを作成してみる

Github Actions入門その1-概要と用語の整理

はじめに

Github Actions とは

CI/CD パイプラインとは

Github Actions が実行されるタイミング ( イベント )

実行環境

概要

Gitでいろいろな形式、方法でタグの一覧を出力する

はじめに

検証環境

シンプルにタグを一覧出力

コミットハッシュと一緒にタグを一覧出力

名前をパターン指定してタグを一覧出力

Gitで最新のタグを取得する方法

はじめに

検証環境

git describe --tags コマンドを使う

実際に試してみる

Semantic Versioning形式のGitタグをインクリメントしてpushするスクリプト

はじめに

検証環境

前提

スクリプト

使い方

Gitリポジトリに誤ってAWSアクセスキーなどをコミットしないようにgit-secretsを導入

はじめに

検証環境

git-secrets とは

インストール

Gitの作業ディレクトリからコマンドでデフォルトブランチ名を取得する

はじめに

検証環境

GitHub CLI を使う

Gitでローカルブランチ、リモートブランチの名前を変更(リネーム)する方法

はじめに

Gitに大容量ファイルをプッシュするときには"Git LFS"を利用しよう

はじめに

検証環境

“Git LFS” がない時

“Git LFS” がある時

direnvと環境変数を使ってGitのユーザ名、メールアドレス、SSH KEYをリポジトリ毎に切り替える

はじめに

検証環境

前提条件（必要なツール）

"git prune"コマンドが何をしてくれるものなのかを操作しながら理解する

はじめに

検証環境

git prune コマンドの「お掃除機能」について

Git でやってしまった！そんなときに変更を取り消す便利なツール "git-branchless"

はじめに

検証環境

git-branchless

"git diff"コマンドの実行結果をGithub風に表示できる"git-split-diffs"

はじめに

検証環境

git-split-diffs とはなに？

前提環境

Gitリポジトリ作成時のデフォルトブランチ名がmainとなるように設定する

はじめに

見つけたツール : `nektos/act`

`nektos/act` ってどんなツール？

`nektos/act` って何をしてくれるに？

`git describe --tags` コマンドを使う

`git prune` コマンドの「お掃除機能」について

`hub-repos.sh`