{"id":31031691,"url":"https://github.com/cssnr/algolia-crawler-action","last_synced_at":"2025-09-14T00:36:03.352Z","repository":{"id":313317970,"uuid":"1050938414","full_name":"cssnr/algolia-crawler-action","owner":"cssnr","description":"Algolia Crawler Action to Start a crawl and Reindex your Site for All Accounts.","archived":false,"fork":false,"pushed_at":"2025-09-05T08:07:28.000Z","size":348,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-05T09:30:28.332Z","etag":null,"topics":["algolia"],"latest_commit_sha":null,"homepage":"https://cssnr.github.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cssnr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"ko_fi":"cssnr"}},"created_at":"2025-09-05T07:21:37.000Z","updated_at":"2025-09-05T08:29:12.000Z","dependencies_parsed_at":"2025-09-05T09:30:33.067Z","dependency_job_id":"3cfd248e-6362-45eb-832c-8be01e1178d8","html_url":"https://github.com/cssnr/algolia-crawler-action","commit_stats":null,"previous_names":["cssnr/algolia-crawler-action"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/cssnr/algolia-crawler-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Falgolia-crawler-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Falgolia-crawler-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Falgolia-crawler-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Falgolia-crawler-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cssnr","download_url":"https://codeload.github.com/cssnr/algolia-crawler-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Falgolia-crawler-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275047902,"owners_count":25396334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-13T02:00:10.085Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algolia"],"created_at":"2025-09-14T00:35:58.443Z","updated_at":"2025-09-14T00:36:03.317Z","avatar_url":"https://github.com/cssnr.png","language":"JavaScript","funding_links":["https://ko-fi.com/cssnr"],"categories":[],"sub_categories":[],"readme":"[![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/algolia-crawler-action?sort=semver\u0026filter=!v*.*\u0026logo=git\u0026logoColor=white\u0026labelColor=585858\u0026label=%20)](https://github.com/cssnr/algolia-crawler-action/tags)\n[![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/algolia-crawler-action?sort=semver\u0026filter=!v*.*.*\u0026logo=git\u0026logoColor=white\u0026labelColor=585858\u0026label=%20)](https://github.com/cssnr/algolia-crawler-action/tags)\n[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/algolia-crawler-action?logo=git\u0026logoColor=white\u0026labelColor=585858\u0026label=%20)](https://github.com/cssnr/algolia-crawler-action/releases/latest)\n[![GitHub Dist Size](https://img.shields.io/github/size/cssnr/algolia-crawler-action/dist%2Findex.js?label=dist%20size)](https://github.com/cssnr/algolia-crawler-action/blob/master/src/index.js)\n[![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/algolia-crawler-action/release.yaml?logo=cachet\u0026label=release)](https://github.com/cssnr/algolia-crawler-action/actions/workflows/release.yaml)\n[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/algolia-crawler-action/lint.yaml?logo=cachet\u0026label=lint)](https://github.com/cssnr/algolia-crawler-action/actions/workflows/lint.yaml)\n[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/algolia-crawler-action?logo=github\u0026label=updated)](https://github.com/cssnr/algolia-crawler-action/pulse)\n[![Codeberg Last Commit](https://img.shields.io/gitea/last-commit/cssnr/algolia-crawler-action/master?gitea_url=https%3A%2F%2Fcodeberg.org%2F\u0026logo=codeberg\u0026logoColor=white\u0026label=updated)](https://codeberg.org/cssnr/algolia-crawler-action)\n[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/algolia-crawler-action?logo=bookstack\u0026logoColor=white\u0026label=repo%20size)](https://github.com/cssnr/algolia-crawler-action)\n[![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/algolia-crawler-action?logo=htmx)](https://github.com/cssnr/algolia-crawler-action)\n[![GitHub Forks](https://img.shields.io/github/forks/cssnr/algolia-crawler-action?style=flat\u0026logo=github)](https://github.com/cssnr/algolia-crawler-action/forks)\n[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/algolia-crawler-action?style=flat\u0026logo=github)](https://github.com/cssnr/algolia-crawler-action/stargazers)\n[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat\u0026logo=github\u0026label=org%20stars)](https://cssnr.github.io/)\n[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord\u0026logoColor=white\u0026label=discord\u0026color=7289da)](https://discord.gg/wXy6m2X8wY)\n[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi\u0026label=support)](https://ko-fi.com/cssnr)\n\n# Algolia Crawler Action\n\n- [Inputs](#Inputs)\n- [Outputs](#Outputs)\n- [Examples](#Examples)\n- [Tags](#Tags)\n- [Support](#Support)\n- [Contributing](#Contributing)\n\nEasily run the Algolia Crawler after a deployment. Works for free accounts including DocSearch.\nOnly requires your Crawler Credentials; Crawler ID, Crawler User ID, and Crawler API Key.\n\nThis uses the Algolia API to [Start a crawl](https://www.algolia.com/doc/rest-api/crawler/#tag/actions/operation/startReindex).\n\nAn alternative to this action is to use a simple [web-request-action](https://github.com/cssnr/web-request-action?tab=readme-ov-file#examples).\n\n```yaml\n- name: 'Algolia Crawler'\n uses: cssnr/algolia-crawler-action@v1\n with:\n crawler_id: ${{ secrets.CRAWLER_ID }}\n crawler_user_id: ${{ secrets.CRAWLER_USER_ID }}\n crawler_api_key: ${{ secrets.CRAWLER_API_KEY }}\n```\n\nMake sure to review the [Inputs](#inputs) and checkout more [Examples](#examples).\n\nThis is an extremely simple action, for more details see [src/index.js](src/index.js).\n\n\u003e [!NOTE] \n\u003e Please submit a [Feature Request](https://github.com/cssnr/algolia-crawler-action/discussions/categories/feature-requests)\n\u003e for new features or [Open an Issue](https://github.com/cssnr/algolia-crawler-action/issues) if you find any bugs.\n\n## Inputs\n\n| Input | Short\u0026nbsp;Description\u0026nbsp;of\u0026nbsp;Input |\n| :-------------- | :---------------------------------------------------- |\n| crawler_id | Crawlers \u003e Your Cralwer \u003e Settings \u003e `Crawler ID` |\n| crawler_user_id | Data Sources \u003e Crawler \u003e Settings \u003e `Crawler User Id` |\n| crawler_api_key | Data Sources \u003e Crawler \u003e Settings \u003e `Crawler API Key` |\n\nNote, these are found in Algolia Dashboard under: `Data Sources` \u003e `Crawler`\n\n### Crawler ID\n\nTo find your `crawler_id` you need to select your named crawler from the Crawlers list,\nthen under the `CONFIGURATION` heading, click on `Settings`. From there you can copy your `Crawler ID`.\n\n### Crawler User Id / Crawler API Key\n\nTo find these do not select a crawler from the `Cralwers` tab, instead click on the `Settings` tab.\nFrom there you can copy both the `Crawler User Id` and `Crawler API Key`.\n\nThese are usually the same across your account if you have multiple crawlers. The only variable is the `Cralwer ID`.\n\n## Outputs\n\n| Output | Description |\n| :------ | :------------------------ |\n| status | API Response Status Code |\n| task_id | Resulting Crawler Task ID |\n\n```yaml\n- name: 'Algolia Crawler'\n uses: cssnr/algolia-crawler-action@v1\n id: crawler\n with:\n crawler_id: ${{ secrets.CRAWLER_ID }}\n crawler_user_id: ${{ secrets.CRAWLER_USER_ID }}\n crawler_api_key: ${{ secrets.CRAWLER_API_KEY }}\n\n- name: 'Echo Output'\n run: |\n echo \"Status Code: ${{ steps.crawler.outputs.status }}\"\n echo \"Task ID: ${{ steps.crawler.outputs.task_id }}\"\n```\n\n## Examples\n\nšŸ’” _Click on an example heading to expand or collapse the example._\n\n\u003cdetails\u003e\u003csummary\u003eGitHub Pages - VitePress\u003c/summary\u003e\n\n```yaml\nname: 'Pages'\n\non:\n push:\n branches:\n - 'master'\n paths:\n - 'docs/**'\n - '.vitepress/**'\n - 'package.json'\n - '.github/workflows/pages.yaml'\n workflow_dispatch:\n\npermissions:\n contents: read\n\nconcurrency:\n group: pages\n cancel-in-progress: false\n\njobs:\n build:\n name: 'Build'\n runs-on: ubuntu-latest\n timeout-minutes: 10\n\n steps:\n - name: 'Checkout'\n uses: actions/checkout@v5\n with:\n fetch-depth: 0\n\n - name: 'Setup Node 22'\n uses: actions/setup-node@v5\n with:\n node-version: 22\n cache: npm\n\n - name: 'Configure Pages'\n uses: actions/configure-pages@v5\n\n - name: 'Install Dependencies'\n run: |\n npm ci\n\n - name: 'Run Build'\n run: |\n npm run build\n\n - name: 'Upload Pages Artifact'\n uses: actions/upload-pages-artifact@v3\n with:\n path: .vitepress/dist\n\n deploy:\n name: 'Deploy'\n runs-on: ubuntu-latest\n timeout-minutes: 5\n needs: build\n\n permissions:\n pages: write\n id-token: write\n\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n\n steps:\n - name: 'Deploy Pages'\n id: deployment\n uses: actions/deploy-pages@v4\n\n post:\n name: 'Post-Deploy'\n runs-on: ubuntu-latest\n timeout-minutes: 5\n needs: deploy\n\n steps:\n - name: 'Algolia Crawler'\n uses: cssnr/algolia-crawler-action@v1\n with:\n crawler_id: ${{ secrets.CRAWLER_ID }}\n crawler_user_id: ${{ secrets.CRAWLER_USER_ID }}\n crawler_api_key: ${{ secrets.CRAWLER_API_KEY }}\n```\n\n\u003c/details\u003e\n\n## Tags\n\nThe following rolling [tags](https://github.com/cssnr/algolia-crawler-action/tags) are maintained.\n\n| Tag | Example | Target | Bugs | Feat. | Description |\n| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------- | :------- | :--: | :---: | :-------------------------------------------------------- |\n| [![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/algolia-crawler-action?sort=semver\u0026filter=!v*.*\u0026style=for-the-badge\u0026label=%20\u0026color=limegreen)](https://github.com/cssnr/algolia-crawler-action/releases/latest) | `vN` | `vN.x.x` | āœ… | āœ… | Includes new features but is always backwards compatible. |\n| [![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/algolia-crawler-action?sort=semver\u0026filter=!v*.*.*\u0026style=for-the-badge\u0026label=%20\u0026color=yellowgreen)](https://github.com/cssnr/algolia-crawler-action/releases/latest) | `vN.N` | `vN.N.x` | āœ… | āŒ | Only receives bug fixes. This is the most stable tag. |\n| [![GitHub Release](https://img.shields.io/github/v/release/cssnr/algolia-crawler-action?style=for-the-badge\u0026label=%20\u0026color=orange)](https://github.com/cssnr/algolia-crawler-action/releases/latest) | `vN.N.N` | `vN.N.N` | āŒ | āŒ | Not a rolling tag. **Not** recommended. |\n\nYou can view the release notes for each version on the [releases](https://github.com/cssnr/algolia-crawler-action/releases) page.\n\n# Support\n\nFor general help or to request a feature, see:\n\n- Q\u0026A Discussion: https://github.com/cssnr/algolia-crawler-action/discussions/categories/q-a\n- Request a Feature: https://github.com/cssnr/algolia-crawler-action/discussions/categories/feature-requests\n\nIf you are experiencing an issue/bug or getting unexpected results, you can:\n\n- Report an Issue: https://github.com/cssnr/algolia-crawler-action/issues\n- Chat with us on Discord: https://discord.gg/wXy6m2X8wY\n- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Web%20Request%20Action)\n\nFor more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.github/blob/master/.github/SUPPORT.md#support).\n\n# Contributing\n\nPlease consider making a donation to support the development of this project\nand [additional](https://cssnr.com/) open source projects.\n\n[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr)\n\nIf you would like to submit a PR, please review the [CONTRIBUTING.md](#contributing-ov-file).\n\nAdditionally, you can support other GitHub Actions I have published:\n\n- [Stack Deploy Action](https://github.com/cssnr/stack-deploy-action?tab=readme-ov-file#readme)\n- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme)\n- [VirusTotal Action](https://github.com/cssnr/virustotal-action?tab=readme-ov-file#readme)\n- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action?tab=readme-ov-file#readme)\n- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action?tab=readme-ov-file#readme)\n- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action?tab=readme-ov-file#readme)\n- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action?tab=readme-ov-file#readme)\n- [Cloudflare Purge Cache Action](https://github.com/cssnr/cloudflare-purge-cache-action?tab=readme-ov-file#readme)\n- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action?tab=readme-ov-file#readme)\n- [Docker Tags Action](https://github.com/cssnr/docker-tags-action?tab=readme-ov-file#readme)\n- [Package Changelog Action](https://github.com/cssnr/package-changelog-action?tab=readme-ov-file#readme)\n- [NPM Outdated Check Action](https://github.com/cssnr/npm-outdated-action?tab=readme-ov-file#readme)\n\nFor a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssnr%2Falgolia-crawler-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcssnr%2Falgolia-crawler-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssnr%2Falgolia-crawler-action/lists"}