Algolia Crawler GitHub Action について

Algolia Advent Calendar 2021の12月24日の記事です。こちらは先日公開されましたAlgolia Crawler Github Actionをご紹介するものになります。

Algolia Crawler GitHub Actionとは

Algolia Crawler GitHub Actionとは

Algolia Crawlerは自動的にWebサイトのコンテンツをAlgoliaにIndexingするもので、このAlgolia Crawler GitHub ActionはCrawlerのPublic APIにアクセスできるAlgoliaユーザーのみが利用できるものとなります。

Algolia Crawlerに関してはこちらをご覧ください。

サポートしているプラットフォーム

site-urlをご提供いただければ、どのプラットフォームでも動作するかと思いますが、私どもの方でテストをしているのは以下になります。

Github Pages
Microsoft Azure
Netlify
Vercel

GitHub Actionをワークフローに追加する方法

GitHub Workflow ファイルの .github/workflows/[FILENAME].yml を作成する。
新しいjobをWebサイトのデプロイの後に追加する。Crawlerが動作するには running なWebサイトが必要です。

  - name: Algolia crawler creation and crawl
    uses: algolia/algoliasearch-crawler-github-actions@v1.0.10
    id: algolia_crawler
    with: # mandatory parameters
      crawler-user-id: ${{ secrets.CRAWLER_USER_ID }}
      crawler-api-key: ${{ secrets.CRAWLER_API_KEY }}
      algolia-app-id: ${{ secrets.ALGOLIA_APP_ID }}
      algolia-api-key: ${{ secrets.ALGOLIA_API_KEY }}
      site-url: 'https://example.com'

設定例

提供しているパラメーター

必須パラメーター

crawler-user-id CrawlerアカウントのUser ID
crawler-api-key CrawlerアカウントのAPI Key
algolia-app-id AlgoliaのApplication ID
algolia-api-key AlgoliaのAPI Key
site-url クロールするWebサイトのURL

オプショナルパラメーター

crawler-api-base-url CrawlerのベースURL。デフォルト: https://crawler.algolia.com/api/1/
crawler-name 作成するCrawlerの名前。デフォルト: '[Github] ${{ github.repository }} ${{ github.ref }}'
override-config Crawlerの設定を上書きするか否かのBoolean値。デフォルト: false
github-token PRにコメントを追加する際に必要。デフォルト: Github Action ${{ github.token }} variable

リポジトリ中のGitHub secrets

AlgoliaやCrawlerのクレデンシャルといったセンシティブな情報はYAMLファイルに直接書き込むのではなく、GitHub secrets(Settings > Secretsで設定)をご利用になることを強くお勧めします。

推奨

ALGOLIA_API_KEY Algolia Application ID
ALGOLIA_APP_ID Algolia API Key
CRAWLER_API_KEY Api Key of your crawler account
CRAWLER_USER_ID User Id of your crawler account

トラブルシュート

お困りの場合は私たちの Discourse forum をご覧ください。
プラグインに不具合を見つけた場合は contributing guide をご覧いただいた上、issue もしくは pull request をオープンしてください。
もし問題に対する回答にたどり着けなかった場合は support@algolia.com までご連絡ください。