{"id":28840782,"url":"https://github.com/algolia/algoliasearch-crawler-github-actions","last_synced_at":"2026-03-17T12:38:22.129Z","repository":{"id":37039182,"uuid":"372864706","full_name":"algolia/algoliasearch-crawler-github-actions","owner":"algolia","description":"Algolia Crawler Github action","archived":false,"fork":false,"pushed_at":"2026-03-13T20:01:22.000Z","size":29925,"stargazers_count":41,"open_issues_count":54,"forks_count":4,"subscribers_count":45,"default_branch":"main","last_synced_at":"2026-03-14T07:54:41.916Z","etag":null,"topics":["actions","algolia","github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/algolia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"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}},"created_at":"2021-06-01T14:46:10.000Z","updated_at":"2025-08-27T14:12:56.000Z","dependencies_parsed_at":"2026-03-13T22:04:28.380Z","dependency_job_id":null,"html_url":"https://github.com/algolia/algoliasearch-crawler-github-actions","commit_stats":{"total_commits":532,"total_committers":8,"mean_commits":66.5,"dds":"0.34398496240601506","last_synced_commit":"81a0bd9e7956d411f3321d7d5af970117403a8b3"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"purl":"pkg:github/algolia/algoliasearch-crawler-github-actions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Falgoliasearch-crawler-github-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Falgoliasearch-crawler-github-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Falgoliasearch-crawler-github-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Falgoliasearch-crawler-github-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algolia","download_url":"https://codeload.github.com/algolia/algoliasearch-crawler-github-actions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Falgoliasearch-crawler-github-actions/sbom","scorecard":{"id":113309,"data":{"date":"2025-08-11","repo":{"name":"github.com/algolia/algoliasearch-crawler-github-actions","commit":"81a0bd9e7956d411f3321d7d5af970117403a8b3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 1/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/github_pages.yml:1","Warn: no topLevel permission defined: .github/workflows/netlify.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/github_pages.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/algoliasearch-crawler-github-actions/github_pages.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/netlify.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/algoliasearch-crawler-github-actions/netlify.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"23 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T17:39:31.721Z","repository_id":37039182,"created_at":"2025-08-15T17:39:31.721Z","updated_at":"2025-08-15T17:39:31.721Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30623666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T11:26:08.186Z","status":"ssl_error","status_checked_at":"2026-03-17T11:24:37.311Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["actions","algolia","github-actions"],"created_at":"2025-06-19T15:41:28.753Z","updated_at":"2026-03-17T12:38:22.125Z","avatar_url":"https://github.com/algolia.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cimg alt=\"Algolia Crawler Github Action\"  src=\"/cover.jpg\" width=\"100%\"/\u003e\n\n[![CircleCI](https://circleci.com/gh/algolia/algoliasearch-crawler-github-actions/tree/main.svg?style=svg)](https://circleci.com/gh/algolia/algoliasearch-crawler-github-actions/tree/main)\n\n# Algolia Crawler Github Action\n\nAutomatically index your website to Algolia when deploying your website with the Algolia Crawler.\n**IMPORTANT**: This Github Action is **only available for Algolia users with Crawler Public API access**.\n\n- [What is Algolia?](https://www.algolia.com/doc/guides/getting-started/what-is-algolia/)\n- [What is Algolia's Crawler?](https://www.algolia.com/doc/tools/crawler/getting-started/overview/)\n\n## Platforms support\n\nIt should be compatible with **any hosts** as long as you provide the correct `site-url`.\nOn top of that, it has been tested with the following platforms:\n\n- Github Pages\n- Microsoft Azure\n- Netlify\n- Vercel\n\n## How to add this Github Action to your workflow ?\n\nOn your repository:\n\n- Create a Github Workflow file `.github/workflows/[FILENAME].yml`.\n- Add a new job after your website deployment. For the Crawler to work, it needs an up and running website.\n\n```yaml\n  - name: Algolia crawler creation and crawl\n    uses: algolia/algoliasearch-crawler-github-actions@v1.0.10\n    id: algolia_crawler\n    with: # mandatory parameters\n      crawler-user-id: ${{ secrets.CRAWLER_USER_ID }}\n      crawler-api-key: ${{ secrets.CRAWLER_API_KEY }}\n      algolia-app-id: ${{ secrets.ALGOLIA_APP_ID }}\n      algolia-api-key: ${{ secrets.ALGOLIA_API_KEY }}\n      site-url: 'https://example.com'\n```\n\n## Example\n\n- [Basic](/examples/basic.yml)\n- [Github Pages](/examples/github_pages.yml)\n- [Netlify](/examples/netlify.yml)\n- Vercel: [PR](/examples/vercel_pr.yml), [Main branch](/examples/vercel_push.yml)\n\n## Parameters to provide\n\n### Mandatory parameters\n\n- `crawler-user-id`\n\n  User Id of your crawler account\n- `crawler-api-key`\n\n  Api Key of your crawler account\n- `algolia-app-id`\n\n  Algolia Application ID\n- `algolia-api-key`\n\n  Algolia API Key\n- `site-url`\n\n  URL of the website to crawl\n\n### Optional parameters\n\n- `crawler-api-base-url`\n\n  Base URL of the crawler, default: [https://crawler.algolia.com/api/1/](https://crawler.algolia.com/api/1/)\n- `crawler-name`\n\n  Name of the created crawler, default: `'[Github] ${{ github.repository }} ${{ github.ref }}'`\n- `override-config`\n\n  Boolean to define if you want your crawler config to be overriden or not, default: `false`\n- `github-token`\n\n  Needed for adding comments to PR, default: Github Action `${{ github.token }}` variable\n\n## Github secrets on your repository\n\nWe 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 \u003e Secrets).\n\n### Recommended\n\n- `ALGOLIA_API_KEY`\n\n  Algolia Application ID\n- `ALGOLIA_APP_ID`\n\n  Algolia API Key\n- `CRAWLER_API_KEY`\n\n  Api Key of your crawler account\n- `CRAWLER_USER_ID`\n\n  User Id of your crawler account\n\n## Troubleshooting\n\n- Need help? We have you covered in our [Discourse forum](https://discourse.algolia.com/)\n- Found a bug in the plugin? Please read our [contributing guide](/CONTRIBUTING.md) and either open an [issue](https://github.com/algolia/algoliasearch-crawler-github-actions/issues) or a [pull request](https://github.com/algolia/algoliasearch-crawler-github-actions/pulls)\n- Can't find the answer to your issue? Please reach out to the [Algolia Support Team](https://alg.li/support).\n\n## Development \u0026 Release\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Falgoliasearch-crawler-github-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgolia%2Falgoliasearch-crawler-github-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Falgoliasearch-crawler-github-actions/lists"}