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

Github Copilot in the CLI を使ってみる

Wed, 20 Dec 2023 11:08:33 +0900

はじめに

先日Githubからメールが届きました。

1

You have been granted access to GitHub Copilot in the CLI.

ようやく Github Copilot in the CLI が利用できるようになりました。

今までは Vim 環境でだけGithub Copilot を使うことができましたが、コマンドライン環境からCopilotの力を利用できることになるのでしょうか？と思い早速試してみました。

検証環境

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)

作業の流れ ( 作業ログ )

まずはメールのリンクに書かれていたドキュメントページから概要や使い方を学んでいくことにしました。

About GitHub Copilot in the CLI - GitHub Docs

Github Copilot in the CLI の概要

Github Copilot in the CLI を使うと、ターミナル操作中にコマンドの候補を提示してくれたり、コマンドの説明を提示してくれたりするそうです。

OIDCを使ってGithub ActionsからAWSにアクセスする仕組みについて理解を整理してみた

Wed, 16 Aug 2023 17:47:45 +0900

はじめに

Github Actions から AWS クラウドリソースを操作するためにACCESS_KEY、SECRET_ACCESS_KEYを使う方法はもう古い、OIDCを使うのが一般的といわれましたが理解していなかったため整理しました。

検証環境

今回取り上げる CI/CD ( ビルド ) パイプライン は Github Actions に限定しています。

クラウドプロバイダー に関しても、 AWS に限定しています。

ただしアーキテクチャはCI/CDパイプラインがCircleCIやCloudBuild、クラウドプロバイダーがGCPやAzureに置き換えられたとしても適用可能なものと考えられます。

パスワードやアクセストークンを使ってGithub Actionsからクラウドへ認証する方法の問題点

Github ActionsのようなCI/CDパイプラインから、クラウド環境 ( AWS、Azure、GCP… ) にアクセスするケースは多いはずです。

ビルドされたソフトウェアやコンテナイメージはいずれデプロイされますし、デプロイ環境としてクラウド環境 ( ex: AWS ) が利用されることが多いからです。

Github Actionsがクラウド上のリソースにアクセスするために、事前にパスワードやアクセストークンといった認証情報を取得しておく必要があります。

これらの認証情報はGithubの secrets に保存することが多いでしょう。 Github Actionsワークフローは実行のたびに secrets から認証情報を取り出し、これを使ってクラウド環境へのアクセスを可能にします。

しかし、このような secrets を使う方法には問題があります。以下のような手間が発生します。

クラウド上のIAMサービスで認証情報を生成する
生成した認証情報をGithubのsecretsに登録する

つまり、認証情報が二重管理されることになります 。

OIDC ( OpenID Connect ) を使うメリット

そこで登場するのがOIDC ( OpenID Connect ) です。

OIDCを使うと、Github Actionsワークフローがクラウドプロバイダーに対して要求するアクセストークンは、有効期限の短いものとなります。

もちろんOIDC認証による認証をサポートされているクラウドプロバイダーでしか利用できない方式ではありますが、現在はほとんどのクラウドプロバイダー ( AWS、Azune、GCP、HashiCorp Vault… ) がOIDCをサポートしています。

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の作業ディレクトリからコマンドでデフォルトブランチ名を取得する

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 しリモートブランチとして反映されてしまった場合に対応でき ません。

"GitHub CLI"でOrganization内のリポジトリを一覧表示する方法

Fri, 04 Mar 2022 10:59:32 +0900

はじめに

GitHub CLI が便利で愛用しています。 GitHub CLI をインストールすると使えるようになる gh コマンドと、別ツールである ghq コマンドを組み合わせるとコマンドラインライフ（？）がとても快適になります。

さて、GitHub にて新しい組織（Organizations）に所属したとき、この組織が所有するリポジトリの一覧を取得したかったのですが、ほんの少しハマったのでやり方を紹介します。

検証環境

1
2
3
4
5
6
7
8
9


$ uname -moi
arm64 MacBookPro18,3 Darwin

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

$ gh --version
gh version 2.5.2 (2022-03-01)
https://github.com/cli/cli/releases/tag/v2.5.2

`gh` コマンドで普通にリポジトリを一覧

gh コマンドで普通にリポジトリを一覧出力してみましょう。

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


$ gh repo list

Showing 30 of 200 repositories in @genzouw

genzouw/docker-minecraft-server Docker image that provides a Minecraft Server that will automatical... public, fork 1d
genzouw/bin private 1d
genzouw/setup_scripts private 3d
genzouw/myconfig private 4d
genzouw/kanji private 4d
genzouw/golly private 4d
genzouw/haldata-apollo-client private 4d
genzouw/backend private 4d
genzouw/hyakuninissyu private 4d
genzouw/aws-cognito-example-custom-page public 5d
genzouw/ubuntu-sandbox Dockerfile for Ubuntu public 6d
...

自分の所有するリポジトリが一覧表示されます。 200 リポジトリも所有しているんですね。びっくりしました。 掃除しないと。

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 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

今回利用するツール

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

"Prevent Public Repos"を導入してPublicなGithubリポジトリが作成されたら通知させる

Fri, 21 May 2021 16:41:52 +0900

はじめに

お恥ずかしながら、Github 上の Organization 内にメンバーが意図せず Public なリポジトリを作成してしまい、それに気づけなかったことがありました。

プロダクトコードをガシガシコミットされる前に気づけたのですが、「これは危ないな」と思い良い方法を探していたところ、 Github Apps に良さそうなアプリがあったので導入してみました。

検証環境

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.1.8(1)-release (x86_64-apple-darwin20.3.0)

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

“Prevent Public Repos” を利用する

以下の Github Apps が今回の用途にピッタリでした。

Prevent Public Repos | Probot

Public な Github リポジトリが作成されたタイミングで、Critical な Issue を作成してくれます。

Issue が作成されたことで気付けるのか？というのも含めて試してみます。

“Prevent Public Repos” 導入方法

1. Github Apps を追加

Prevent Public Repos のページ右上にある Add to Github ボタンをクリックします。

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ワークスペース内でリモートリポジトリの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

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

GitHub CLIを使ってコマンドラインからイシュー、プルリクを検索、表示してみる

Fri, 03 Apr 2020 22:54:19 +0900

はじめに

今年の 2 月に公開されたばかりの GitHub CLI というコマンドラインツールについて使ってみたので紹介してみます。

今までは hubコマンドを使っていましたが、話題になっているぐらいなので比較して有用性が高いはず、と思って使ってみました。

EC-CUBE の GitHub リポジトリのイシューを覗き見することが最近何度かあったため、イシューを検索、表示してみます。

検証環境

1
2
3
4
5


$ uname -moi
x86_64 MacBookPro11,4 Darwin

$ zsh --version
zsh 5.8 (x86_64-apple-darwin18.7.0)

インストール

Mac はかんたんですね。

今日現在、公式ページには以下のコマンドでインストールできるとありました。

1

$ brew install github/gh/gh

セットアップ

1

$ gh issue list

初めてコマンドを実行する場合は、 GitHub CLI が GitHubAPI を呼び出すための権限を付与する必要があるようです。以下のメッセージが表示されます。

1
2


Notice: authentication required
Press Enter to open github.com in your browser...

Enter キーを押すとブラウザが起動し、以下のようなページが表示されます。

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. ファイルの編集・追加を行う

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

シェルスクリプトで任意のオーナーが所有する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触っていた記憶なんてほとんど無いんですけどね。

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)

インストール

以下を参照

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

Github Copilot in the CLI を使ってみる

はじめに

検証環境

作業の流れ ( 作業ログ )

Github Copilot in the CLI の概要

OIDCを使ってGithub ActionsからAWSにアクセスする仕組みについて理解を整理してみた

はじめに

検証環境

パスワードやアクセストークンを使ってGithub Actionsからクラウドへ認証する方法の問題点

OIDC ( OpenID Connect ) を使うメリット

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の作業ディレクトリからコマンドでデフォルトブランチ名を取得する

はじめに

検証環境

GitHub CLI を使う

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

はじめに

"GitHub CLI"でOrganization内のリポジトリを一覧表示する方法

はじめに

検証環境

gh コマンドで普通にリポジトリを一覧

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

はじめに

検証環境

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

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

はじめに

検証環境

git-split-diffs とはなに？

前提環境

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

はじめに

検証環境

今回の作業の前提

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

はじめに

検証環境

今回利用するツール

"Prevent Public Repos"を導入してPublicなGithubリポジトリが作成されたら通知させる

はじめに

検証環境

“Prevent Public Repos” を利用する

“Prevent Public Repos” 導入方法

1. Github Apps を追加

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

はじめに

検証環境

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

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

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

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

はじめに

検証環境

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

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

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

`gh` コマンドで普通にリポジトリを一覧

`hub-repos.sh`