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

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

先史時代

順番に説明していくと、個人の「About Me」Web サイトを保存するための、高速、便利、簡単、そして無料のオプションを探す過程で、私は数晩かけて多くの記事を調べなければならなかったということは、おそらく言及する価値があるでしょう。

ホスティングを選択する人もいれば、クラウド サーバーを選択する人もいます。また、静的サイトをリポジトリにアップロードするなどの作業、操作、支払いを理解したくない人もいます。これは、現在では GitHub と GitLab の両方で実行できるためです。

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

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

ページについて

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

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

もっと見ることができます ドキュメントの中でただし、GitHub は驚くほど寛大で、ファイルを追加するだけで誰でも自分のドメインをそのようなサイトにリンクできるようにしていることに注意してください。 CNAME ドメイン名を使用して、GitHub サーバー上にドメインプロバイダーの DNS を設定します。

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

問題の発生

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

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

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

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

このサブ項目には特に焦点を当てませんが、以下の項目の選択と使用中に私が思いついたいくつかの仮説を共有します。

1) プログラミング言語に合ったジェネレーター、またはできるだけわかりやすいジェネレーターを選択します。 私自身、サイトが機能するためにいくつかの機能を追加し、サイトの安定性と自動化を高めるために松葉杖を追加する必要があったときに、このアイデアに至りました。 さらに、これはプラグインの形式で追加機能を自分で作成する十分な理由になります。

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

私の発電機の選択は最初の点に基づいています。 ペリカン Python で書かれているので、私にとっては馴染みのない Jekyll を簡単に置き換えることができます。 (XNUMX年近く使用しました)。 その結果、記事の作成や編集、Web サイトでの作業でも、興味のある言語でさらなる経験が得られます。

__

問題の定式化

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

解決のためのツール

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

• 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 リポジトリ設定。 生成中にトークンが一度提供されるだけで、それ以降はアクセスできないことに注意してください。 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 インターフェイスを介してファイルを作成するかにかかわらず、アクションはすべてを自動的に実行します。 スクリプトが予期せずクラッシュした場合、通知が電子メールに送信されます。

完全なコード

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

上記の Secret が使用され、ボット トークンとメッセージの送信先となるユーザー 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

スクリーンショット

ソース リポジトリの [アクション] タブに表示される実行の XNUMX つの結果

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

便利なリンク集

アクションを理解する
アクションの構文
トリガーのリスト
仮想環境のオプション
Githubページ
静的ジェネレーターのリスト

出所： habr.com