Habr を少し調べてみたところ、GitHub (ベータ版) の機能である Actions に関する記事がほとんど公開されていないことに驚きました。

このような省略は、機能が「ベータ版」ではあるものの、まだテスト中であるという事実によって説明できるようです。しかし、このツールをプライベート リポジトリで使用できるようにするのはベータ版の便利な機能です。この記事では、このテクノロジーの使い方について説明します。

先史時代

最初から始めるとすれば、個人ウェブサイト「About me」を保存するための高速で便利、簡単、無料のオプションを検索する過程で、私は数晩を費やして多くの記事を精査しなければならなかったことを言及する価値があるでしょう。

ホスティングを選択する人もいれば、クラウド サーバーを選択する人もいます。また、すべてがどのように機能し、相互作用し、料金を支払うかを理解したくない人もいます。たとえば、GitHub と GitLab の両方で現在可能な、リポジトリへの静的サイトのアップロードなどです。

もちろん、これは各人の個人的な選択です。

最終的に選んだのは GitHub Pages でした。

ページについて

誰も知らない gh-pages — これは、ドキュメントを Web サイトの形式で保存するためのオプションであり、無料で提供されており、ドキュメントに加えて、個人の Web サイトを保存することも提案されています。この機能は GitHub によってすべてのユーザーに提供されており、リポジトリ設定で利用できます。

プロジェクトリポジトリはブランチを使用します gh-pages、ユーザーサイトの場合 - という名前の別のリポジトリ username.github.io サイトのソースは master ブランチ。

詳細は以下をご覧ください ドキュメントの中でしかし、GitHubは驚くほど寛大で、ファイルを追加するだけで誰でも自分のドメインをそのようなサイトにリンクできるようにしています。 CNAME ドメイン名を入力し、ドメイン プロバイダーの DNS を GitHub サーバーに設定します。

このようなサイトを展開する方法については、ここにはたくさんの記事があると思うので、これ以上は説明しません。

問題の出現

問題は、静的ジェネレータを使用する場合、ページを生成してリポジトリにアップロードするプロセスを簡素化するために、追加のスクリプト補助を記述し、ライブラリを使用する必要があることでした。簡単に言えば、ソース コードを別のプライベート リポジトリに保存すると、サイトに変更があるたびに、静的ページを生成してサイトのメイン リポジトリに公開するためのローカル環境を展開する必要があります。

豊富にある 静的発電機 そして彼らは皆同じ​​問題を抱えています。これらのアクションは時間と労力がかかり、特にOSからOSへの複数の移行やハードドライブ上のデータ損失のインシデントの後では、最終的にはサイトの作業が停止します。 （私の場合もそうでした）.

つい最近、サイト上のポップアップ通知または GitHub からのニュースレターで、新しく組み込まれた CI/CD が通知され、これらのアクションを最小限の労力で実行できるようになりました。

静的ページジェネレータについて

このサブ項目については特に焦点を絞るつもりはありませんが、選択と使用中に私がたどり着いたいくつかの論文を共有したいと思います。

1) プログラミング言語に適したジェネレーター、または最も理解しやすいジェネレーターを選択する必要があります。このアイデアを思いついたのは、サイトを機能させるための機能をいくつか書き終え、安定性と自動化を高めるための補助手段を導入しなければならなかったときでした。さらに、これはプラグインの形で追加機能を自分で記述する良い理由でもあります。

2) どのジェネレーターを選択するかは個人の選択ですが、GitHub Pagesの機能に最初に浸るためには、まずインストールする必要があることを考慮する価値があります。 ジキル。幸いなことに、リポジトリ内のソースから直接サイトを生成することができます。 （私の選択でこれを繰り返します）.

私がジェネレーターを選んだのは、最初のポイントに基づいています。 ペリカン Pythonで書かれたものは私にとって異質なJekyllを簡単に置き換えた （約1年間使用）。その結果、記事の作成や編集、サイト上での作業を通じて、私にとって興味のある言語に関するさらなる経験が得られます。

__

問題の定式化

主なタスクは、プライベート リポジトリから静的ページを自動的に生成できるようにするスクリプト (実際には構成ファイル) を作成することです。このソリューションには仮想環境の機能が組み込まれます。スクリプトは、準備完了のページをパブリック リポジトリに自動的に追加します。

解決のためのツール

問題を解決するために使用するツール:

• GitHub アクション;
• Python3.7;
• ペリカン;
• ギット;
• GitHub ページ。

ソリューション

したがって、ドキュメントに少し慣れ、アクションのスクリプトの書き方を理解すると、このメカニズムによって発生した問題が完全に解決されることが明らかになりました。 執筆時点では、この機能を使用するにはサブスクリプションが必要です ベータテスト用!

Github自身による新機能の説明

アクションスクリプトの作成は、フォルダ内に名前付きファイルを作成することから始まります。 .github およびそのサブフォルダ workflows。これは手動で行うことも、リポジトリ ページの [アクション] タブのエディターから行うこともできます。

空白のスクリプトフォームの例

フォームについて簡単にコメントします

name: CI    # название скрипта: будет отображаться во вкладке Actions

on: [push]  # действие, по которому запускается данный скрипт

jobs:       # роботы, которые будут выполняться
  build:    # сборка, которая..

    runs-on: ubuntu-latest      # ..будет запущена на основе этого образа

    steps:              # шаги которые будут проделаны после запуска образа
    - uses: actions/checkout@v1     # переход в самую актуальную ветку
    - name: Run a one-line script   # имя работы номер 1
      run: echo Hello, world!       # суть работы номер 1 (bash-команда записана в одну строку)
    - name: Run a multi-line script   # имя работы номер 2
      run: |                    # суть работы номер 2 (многострочная)
        echo Add other actions to build,
        echo test, and deploy your project.

テンプレートに基づいて独自のものを書いてみましょう。

0) 名前は「CI」のままにすることもできます。それは好みの問題です。

1) 次に、スクリプトを起動するアクション/トリガーを選択する必要があります。この場合、これはリポジトリへの新しいコミットの定期的なプッシュです。

on:
  push

2) スクリプトが起動される基準となる画像も例から除外されます。 Ubuntu 必要な機能という点では非常に満足できる。 利用可能なツール これは、必要なイメージ、または単に便利なイメージ (またはそれに基づく Docker コンテナ) である可能性があることが明らかになります。

  build:
    runs-on: ubuntu-latest

3) 手順としては、まずはメインの作業に向けて環境を整えていきます。

3.1) 必要なブランチに移動します（標準ステップ） checkout):

- uses: actions/checkout@v1

3.2) Pythonをインストールします。

    - name: Set up Python
      uses: actions/setup-python@v1
      with:
        python-version: 3.7

3.3) ジェネレーターの依存関係を設定します。

    - name: Install dependencies
      run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

3.4) サイトページが生成されるディレクトリを作成します。

   - name: Make output folder
      run: mkdir output

4) サイト上の作業に一貫性を持たせるため、つまり以前の変更を削除せず、競合なくサイト リポジトリに変更を追加できるようにするため、次の手順では、毎回サイト リポジトリのクローンを作成します。

   - name: Clone master branch
      run: git clone "https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git" --branch master --single-branch ./output

このステップでは、システム変数を呼び出します。

• 変数 GITHUB_ACTOR GitHub は自動的にインストールされ、これはこのスクリプトを実行させたユーザーの名前です。
• 変数 secrets.ACCESS_TOKEN これは生成される Github管理トークンタブで設定することで環境変数として渡すことができます Secrets リポジトリの設定。 トークンを生成すると、トークンは一度だけ提供され、それ以降はアクセスできなくなることにご注意ください。秘密のアイテムの値も同様です。

5) ページの生成に移りましょう。

   - name: Generate static pages
      run: pelican content -o output -s publishconf.py

ジェネレータに渡されるパラメータは、生成されたファイルが送信されるディレクトリを決定します（-o output) と生成に使用する設定ファイル (-s publishconf.py; ローカル設定と公開用設定を分離する方法についての詳細は、Pelicanのドキュメントをご覧ください。).

フォルダの中にあることを思い出してください output サイト リポジトリはすでにクローンされています。

6) Git をセットアップして、変更したファイルにインデックスを付けましょう。

    - name: Set git config and add changes
      run: |
          git config --global user.email "${GITHUB_ACTOR}@https://users.noreply.github.com/"
          git config --global user.name "${GITHUB_ACTOR}"
          git add --all
      working-directory: ./output

このポイントでは、既知の変数を使用して、このステップのコマンドが起動される作業ディレクトリを指定します。作業ディレクトリに移動するコマンドは次のようになります。 cd output.

7) コミットメッセージを生成し、変更をコミットしてリポジトリにプッシュします。コミットが無駄にならないように、またそれに応じてbashでエラーが発生しないようにします（出力は 0) - まず、何かをコミットしてプッシュする必要があるかどうかを確認しましょう。これを行うには、次のコマンドを使用します。 git diff-index --quiet --cached HEAD -- ターミナルに出力される 0 サイトの以前のバージョンと比較して変更がない場合、 1 そういった変化があります。その後、このコマンドの結果を処理します。この方法では、自動的にクラッシュしてスクリプトのクラッシュに関するレポートを送信するのではなく、この段階でのサイトの状態に関する有用な情報をスクリプト実行情報に記録します。

私たちは、既製のページを使用してディレクトリ内でこれらのアクションも実行します。

   - name: Push and send notification
      run: |
          COMMIT_MESSAGE="Update pages on $(date +'%Y-%m-%d %H:%M:%S')"
          git diff-index --quiet --cached HEAD -- && echo "No changes!" && exit 0 || echo $COMMIT_MESSAGE
          # Only if repo have changes
          git commit -m "${COMMIT_MESSAGE}"
          git push https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git master
      working-directory: ./output

結果

その結果、このようなスクリプトを使用すると、静的ページの作成について考える必要がなくなります。任意のシステムから git を使用して作業する場合でも、GitHub Web インターフェースを介してファイルを作成する場合でも、プライベート リポジトリに直接変更を追加すると、アクションがすべてを自動的に実行します。 予期しないスクリプトの失敗が発生した場合は、電子メールに通知が送信されます。

完全なコード

コミットがメイン リポジトリにプッシュされたことを通知する最後のステップが追加された、作業バージョンを残しておきます。

上記の Secrets が使用され、ボット トークンとメッセージを送信する必要があるユーザー ID が追加されます。

name: Push content to the user's GitHub pages repository

on:
  push

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: Set up Python
      uses: actions/setup-python@v1
      with:
        python-version: 3.7
    - name: Install dependencies
      run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
    - name: Make output folder
      run: mkdir output
    - name: Clone master branch
      run: git clone "https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git" --branch master --single-branch ./output
    - name: Generate static pages
      run: pelican content -o output -s publishconf.py
    - name: Set git config and add changes
      run: |
          git config --global user.email "${GITHUB_ACTOR}@https://users.noreply.github.com/"
          git config --global user.name "${GITHUB_ACTOR}"
          git add --all
      working-directory: ./output
    - name: Push and send notification
      run: |
          COMMIT_MESSAGE="Update pages on $(date +'%Y-%m-%d %H:%M:%S')"
          git diff-index --quiet --cached HEAD -- && echo "No changes!" && exit 0 || echo $COMMIT_MESSAGE
          git commit -m "${COMMIT_MESSAGE}"
          git push https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git master
          curl "https://api.telegram.org/bot${{ secrets.BOT_TOKEN }}/sendMessage?text=$COMMIT_MESSAGE %0ALook at ${GITHUB_ACTOR}.github.io %0ARepository%3A github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io&chat_id=${{ secrets.ADMIN_ID }}"
      working-directory: ./output

スクリーンショット

いずれかの実行の結果がソース リポジトリの [アクション] タブに表示されます。

スクリプトの完了に関するボットからのメッセージ

便利なリンク集

アクションに関する一般情報
アクション構文
トリガーのリスト
仮想環境オプション
Githubページ
静的ジェネレーターリスト

出所： habr.com