githubのアクセストークンを設定
github actionsを用いて自動的にファイルを修正してもらいたい時などがあります.
その際に,自分のリポジトリの情報を取得するために,githubのtokenを設定する必要があります.
今回はそのやり方について詳細に説明をします.
1. githubのtokenを生成
自分のアカウントのリポジトリの情報を取得するために,githubのtokenを生成します.
これをすることで,自分のプライベートリポジトリの情報も取得できるようになります.
- githubの右上のアイコンをクリックして,
Settings
をクリックします. - 左のメニューから
Developer settings
をクリックします. - 左のメニューから
Personal access tokens
をクリックします.
4. Generate new token
をクリックします.
Fine-granted tokensというbeta版のものもありますが,今回は簡単にTokens (classic)
を使用します.
5. tokenの名前を入力し,repo
にチェックを入れて,Generate token
をクリックします.
6. tokenが生成されるので,これをコピーしておきます.
このtokenは一度しか表示されないので,必ずコピーしておきましょう!
2. githubのtokenを設定する
- 自分のアカウント名のリポジトリの
Settings
からSecrets and variables
のactions
を開く
2. Repository secrets
のNew repository secret
をクリックします.
3. Name
にPERSONAL_ACCESS_TOKEN
,Value
に先ほどコピーしたtokenを入力し,Add secret
をクリックします.
4. Settings
のActions
のGeneral
の一番下に,Workflow permissions
とあるので,それのRead and write permissions
を選択します.
これによってgithub actionsが自分のリポジトリにcommit,pushできるようになります.
以上で,githubのtokenの設定が完了しました.
3. github actionsでの利用
せっかくなので,github actionsでの利用方法も記載しておきます.
.github/workflows/auto_commit.yml
として作成します.
name: commit and push
on:
push:
branches:
- main
- master
workflow_dispatch:
jobs:
run-and-commit-notebook:
runs-on: ubuntu-latest
steps:
- name: リポジトリをチェックアウト
uses: actions/checkout@v2
## ここにスクリプトを追加
- name: Commit & Push
env:
ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
run: |
git config user.name github-actions
git config user.email github-actions@github.com
git add -A .
git commit -m "update file name"
git -c http.extraheader="AUTHORIZATION: bearer ${ACCESS_TOKEN}" push
user.nameとuser.emailは,現在githubという仮の名前を設定しています.
自分のアカウントでコミットを行なって欲しい場合は,適宜変更してください.