---
name: algolia-ci-integration
description: >-
  Build and review a bounded CI gate for Algolia index configuration and disposable-index smoke tests. Use when search changes need pull-request evidence without mutating production. Trigger with "Algolia CI", "test Algolia in GitHub Actions", or "search deployment gate".
argument-hint: "[repository-path] [test-index-prefix]"
allowed-tools: Read, Glob, Grep, WebFetch, Write, Edit
version: 1.8.0
author: Jeremy Longshore <jeremy@intentsolutions.io>
license: MIT
tags:
  - saas
  - algolia
  - ci
model: inherit
effort: medium
compatibility: Designed for Claude Code
title: algolia-ci-integration
canonical_url: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/algolia-ci-integration
last_updated: 2026-10-07T06:06:28.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [references/official-docs.md](https://skilld.dev/api/skills-raw/jeremylongshore/tons-of-skills-marketplace/algolia-ci-integration/references/official-docs.md).
>
> If the user asked to install this Skill, run `npx skilld install jeremylongshore/tons-of-skills-marketplace/algolia-ci-integration`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/algolia-ci-integration`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/jeremylongshore/tons-of-skills-marketplace/algolia-ci-integration) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/algolia-ci-integration`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/algolia-ci-integration --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/algolia-ci-integration --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Algolia CI Integration

## Overview

This skill adds a deterministic CI lane for code that owns Algolia records, settings, or query behavior. It separates offline contract tests from an optional network smoke test against an explicitly disposable index.

## Prerequisites

- A named repository, environment, and Algolia application or index in scope
- The local lockfile and installed client types as implementation authority
- A safe read-only query or explicitly disposable test target
- Current first-party documentation for any provider behavior that affects the change

## Tool Discipline

Use `Read`, `Glob`, and `Grep` to inspect local code, configuration names, tests, and dependency versions. Use `WebFetch` only for current official Algolia documentation. Use `Write` or `Edit` only after identifying the target files, constraints, and verification plan.

## Current Contract

- Pin the Node dependency and runner version already supported by the repository.
- Keep production application IDs, index names, and write credentials out of pull-request workflows.
- Name disposable indices with a run-specific suffix and record their cleanup result.
- Test the exact client methods used by the application; for JavaScript v5, index operations live on the client.

## Authentication

Use a repository secret containing a custom key limited to the disposable index and required ACLs. Do not use an Admin key or expose any write key to forked pull requests.

## Instructions

1. Map the package manager, test runner, Algolia wrapper, and current CI event permissions.
2. Add offline tests for record shaping, settings serialization, and query contracts.
3. Make the live smoke job opt-in or protected, with a unique non-production index name.
4. Create records, wait for the task, perform one known query, and collect request IDs on failure.
5. Delete the disposable index in a guaranteed cleanup step and report cleanup failure separately.
6. Verify untrusted forks cannot read secrets or execute the credentialed job.

## Approval Boundaries

Do not enable secrets for untrusted fork code, reuse a production index, or delete an index whose generated name was not validated. Require review for workflow-permission changes.

## Output

Return the workflow diff, secret and ACL requirements, offline results, smoke-test evidence, cleanup receipt, and the exact conditions under which the network job runs.

## Error Handling

| Condition | Response |
|---|---|
| Secret unavailable | Skip the protected smoke job while keeping offline tests required. |
| Index name is not disposable | Fail before the first write. |
| Task does not complete | Capture task ID and request ID; preserve cleanup. |
| Cleanup fails | Fail the job and identify the retained test index. |

## Examples

Use this compact input and expected handoff to calibrate scope and evidence quality.

Input:

```text
repository=search-service; event=pull_request; smoke=protected
```

Expected handoff:

```text
offline=pass; live=skipped-for-fork; production-writes=0
```

## Resources

- [Skill-specific official documentation](https://skilld.dev/api/skills-raw/jeremylongshore/tons-of-skills-marketplace/algolia-ci-integration/references/official-docs.md)
- [JavaScript API client](https://www.algolia.com/doc/libraries/javascript)
- [API keys](https://www.algolia.com/doc/guides/security/api-keys)
- [JavaScript v5 upgrade](https://www.algolia.com/doc/libraries/sdk/upgrade/javascript)
