Skip to content

algolia/algoliasearch-crawler-github-actions

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Algolia Crawler Github Action

CircleCI

Algolia Crawler Github Action

Automatically index your website to Algolia when deploying your website with the Algolia Crawler. IMPORTANT: This Github Action is only available for Algolia users with Crawler Public API access.

Platforms support

It should be compatible with any hosts as long as you provide the correct site-url. On top of that, it has been tested with the following platforms:

  • Github Pages
  • Microsoft Azure
  • Netlify
  • Vercel

How to add this Github Action to your workflow ?

On your repository:

  • Create a Github Workflow file .github/workflows/[FILENAME].yml.
  • Add a new job after your website deployment. For the Crawler to work, it needs an up and running website.
  - 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'

Example

Parameters to provide

Mandatory parameters

  • crawler-user-id

    User Id of your crawler account

  • crawler-api-key

    Api Key of your crawler account

  • algolia-app-id

    Algolia Application ID

  • algolia-api-key

    Algolia API Key

  • site-url

    URL of the website to crawl

Optional parameters

  • crawler-api-base-url

    Base URL of the crawler, default: https://crawler.algolia.com/api/1/

  • crawler-name

    Name of the created crawler, default: '[Github] ${{ github.repository }} ${{ github.ref }}'

  • override-config

    Boolean to define if you want your crawler config to be overriden or not, default: false

  • github-token

    Needed for adding comments to PR, default: Github Action ${{ github.token }} variable

Github secrets on your repository

We highly recommend not to define sensitive information such as Algolia and/or Crawler credentials directly in the YAML file and to use Github secrets (defined in Settings > Secrets).

Recommended

  • 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

Troubleshooting

Development & Release

See CONTRIBUTING.md.