{"repo":"algolia/algoliasearch-crawler-github-actions","free":true,"listed":false,"github":"https://github.com/algolia/algoliasearch-crawler-github-actions","clone":"git clone https://github.com/algolia/algoliasearch-crawler-github-actions.git","description":"Algolia Crawler Github action","language":"TypeScript","stars":40,"topics":["github-actions","algolia","actions"],"license":"MIT","category":"scrapers-browser-automation","readme_excerpt":"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 . - What is Algolia? - What is Algolia's Crawler? 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. Example - Basic - Github Pages - Netlify - Vercel: PR, Main branch 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 sec","default_branch":null,"files":null,"tree":[],"storefront":"/r/algolia","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/algolia/algoliasearch-crawler-github-actions/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}