🐺

GitHub App の token で clone する方法

に公開
GitHub
GitHub Actions
githubapp
tech

はじめに

github appで作成したinstallation access tokenを使用してcloneする方法を探してみた

結論

git clone https://x-access-token:TOKEN@github.com/owner/repo.gitによるclone

HTTPパスワードとして利用する

x-access-tokenにinstallation access tokenを付与するとHTTPパスワードの代わりとなるらしい

インストール アクセス トークンを使って、HTTP ベースの Git アクセスの認証を行うこともできます。 アプリには、"コンテンツ" リポジトリのアクセス許可が必要です。 その後は、インストール アクセス トークンを HTTP パスワードとして使用できます。 TOKEN をインストール アクセス トークンに置き換えます: git clone https://x-access-token:TOKEN@github.com/owner/repo.git。

https://docs.github.com/ja/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation#github-app-インストールとしての認証について

アクセス権限の範囲

installation access tokenを利用した認証を行うために必要な権限

  • Contents
  • Workflows

https://docs.github.com/ja/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app

personal access token について

REST APIやコマンドで使用する際に、GitHubに対する認証方法としてpersonal access tokenを使用できる。

https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens

下記ドキュメントにもHTTPS URLを使ったクローン時の認証にpersonal access tokenを使用できると記載されている。

https://docs.github.com/ja/get-started/git-basics/about-remote-repositories#cloning-with-https-urls

Tips

tagの指定を行う場合

git clone --branch latest --no-tags --single-branch https://x-access-token:TOKEN@github.com/owner/repo.git
  • --branchでtagを指定
  • --no-tagsで他のtagを排除
  • --single-branchで指定したtagのみcloneする

Discussion