GitHub Actionsでカバレッジを表示するハンズオン

環境構築

connpass-clientをforkします

https://github.com/fin-py/connpass-client にアクセスし、 Fork をクリックします

Create fork をクリックします

forkしたリポジトリから Settings -> Actions -> Workflow permissions から Read and write permissions を選択して Save します

forkしたリポジトリをclone し、カレントディレクトリを移動します

git clone git@github.com:<your github account>/connpass-client.git
cd connpass-client

仮想環境にインストール

Attention

Poetryを使う場合は Poetryを使って仮想環境にインストールに進んでください。

仮想環境を作成します。実行環境の合わせて python は python3 などに置き換えてください。

python -m venv .venv

Note

Windwsの場合は py コマンドから仮想環境を作成します。

py -m venv .venv

仮想環境を有効化します。

source .venv/bin/activate

Note

WindwsでPowerShellを使う場合、スクリプトの実行許可を与えていない場合は次のコマンドを1回だけ実行します。

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Force

仮想環境を有効化します。

.venv\Scripts\activate

パッケージをインストールします。

python -m pip install pip -U
pip install . pytest coverage pytest-cov "genbadge[coverage]"

Poetryを使って仮想環境にインストール

Caution

仮想環境にインストールの手順を実施している場合は以降の手順は不要です。

virtualenvs.in-project の設定を確認します。

poetry config --list

virtualenvs.in-project = true になっていなければ、仮想環境をカレントディレクトリに生成する設定にします（オプション）。

poetry config --local virtualenvs.in-project true

Note

virtualenvs.in-project の設定をグローバルにするには --local を省略します。

poetry config virtualenvs.in-project true

参考: virtualenvs.in-project

Poetryの環境にインストールします。

poetry install

Poetryの環境を有効化します。

poetry shell

はじめてのGitHub Actions

GitHub Actions のクイックスタートの手順に従って、GitHub Actionsを実行してみます

.github/workflows ディレクトリを作成します

mkdir -p .github/workflows

.github/workflows/github-actions-demo.yml ファイルを作成し、下記の内容を記述します

name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v3
      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - run: echo "🍏 This job's status is ${{ job.status }}."

See also

ワークフローファイルを理解する

コミット、プッシュします

git add .
git commit -m "Add Github Actions example"
git push orgin main

ブラウザからforkしたリポジトリにアクセスし、 Actions からワークフローの結果を確認します

ワークルフローをクリック

ジョブ（ Explore-GitHub-Actions ）をクリック

GitHub Actionsによるカバレッジの実行

ここでは次の内容をGitHub Actionsを利用して実行します

カバレッジのレポートを生成（HTML、XML）
XMLファイルをもとに、カバレッジのバッジを生成
レポート（HTML）とバッジを coverage ブランチにコミット・プッシュ

YAMLファイルの作成

.github/workflows/coverage.yml ファイルを作成し、下記の内容を記述します

name: coverage
on:
  push:
    branches: [ main ]
env:
  BRANCH_NAME: coverage
jobs:
  generate-coverage:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3
      - name: pip install
        uses: actions/setup-python@v3
        with:
          python-version: '3.10'
      - run: |
          python -m pip install --upgrade pip
          python -m pip install pytest coverage pytest-cov "genbadge[coverage]"
      - name: genarate coverage and badge
        run: |
          pytest --cov=connpass_client tests
          coverage html
          mv htmlcov/* .
          coverage xml
          genbadge coverage -i - < coverage.xml
      - name: commit and push
        run: |
          git config --local user.email "actions@github.com"
          git config --local user.name "GitHub Actions"
          git fetch origin $BRANCH_NAME && git push --delete origin $BRANCH_NAME
          git checkout --orphan $BRANCH_NAME
          git rm -rf .
          git add .
          git commit -m "generate coverage"
          git push origin $BRANCH_NAME

on:
  push:
    branches: [ main ]

main ブランチにプッシュされた場合に、ワークフローにトリガーされます

See also

ワークフローのトリガー

env:
  BRANCH_NAME: coverage

環境変数 BRANCH_NAME に coverage を設定しています

See also

環境変数の設定

        uses: actions/checkout@v3

このステップで actions/checkout@v3 を実行します

リポジトリをランナーにチェックアウトするアクションであり、コードに対してスクリプトまたはほかのアクション (ビルド、ツールやテスト、ツールなど) を実行できます

See also

GitHub Actions を理解する

        uses: actions/setup-python@v3
        with:
          python-version: '3.10'

このステップで actions/setup-python@v3 を実行します

このアクションは、GitHub Actionsのユーザーに対して、次の機能を提供します

PythonまたはPyPyのバージョンをインストールし、（デフォルトで）PATHに追加
オプションでpip、pipenv、poetryの依存関係をキャッシュ
エラー出力のためのプロブレムマッチャーを登録

          coverage html
          mv htmlcov/* .
          coverage xml

Coverage.py を利用してカバレッジのレポートを生成しています

coverage html コマンドでカバレッジのレポートをHTML形式に出力します

See also

HTML reporting: coverage html

coverage xml コマンドでカバレッジデータを Cobertura と互換性のあるXML形式に出力します

See also

XML reporting: coverage xml

26          genbadge coverage -i - < coverage.xml

genbadge を利用してバッジを生成します

          git fetch origin $BRANCH_NAME && git push --delete origin $BRANCH_NAME

$BRANCH_NAME ブランチを確認し、ブランチが存在している場合は削除します

32          git checkout --orphan $BRANCH_NAME

空の $BRANCH_NAME ブランチを生成します

ワークフローの実行

コミット、プッシュします

git add .
git commit -m "Add Github Actions coverage"
git push orgin main

ブラウザからforkしたリポジトリにアクセスし、 Actions からワークフローの結果を確認します

リポジトリの Code に移動し、 coverage ブランチがあることを確認します

coverage ブランチに coverage-badge.svg が作成されていることを確認します

GitHub Pagesの設定

リポジトリの Settins -> Pages から Branch を coverage 、 /(root) に変更して、 Save します

Actions で pages build and deployment が実行されたことを確認します

deploy に表示されているリンク（ https://<your github account>/connpass-client/ ）を開き、カバレッジがHTMLで表示されることを確認します

READMEに追加

README.md 2行目以降に次の行を追加します

[![Coverage Status](https://raw.githubusercontent.com/<your github account>/connpass-client/coverage/coverage-badge.svg)](https://<your github account>.github.io/connpass-client/)

コミット、プッシュしてREADMEにバッジが表示されていることを確認します

GitHub Actionsでカバレッジを表示するハンズオン

環境構築

仮想環境にインストール

Poetryを使って仮想環境にインストール

はじめてのGitHub Actions

GitHub Actionsによるカバレッジの実行

YAMLファイルの作成

ワークフローの実行

GitHub Pagesの設定

READMEに追加

Indices and tables