Skip to content

fix(ci): switch Algolia reindex to crawler v1 API #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elibosley merged 1 commit into from
Apr 1, 2026
+30 −19
Merged

fix(ci): switch Algolia reindex to crawler v1 API #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 26 additions & 16 deletions .github/workflows/algolia-reindex.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,21 +51,29 @@ jobs:
response="$(
curl --silent --show-error --fail \
--user "${ALGOLIA_CRAWLER_USER_ID}:${ALGOLIA_CRAWLER_API_KEY}" \
"https://crawler.algolia.com/api/user_configs?appId=${ALGOLIA_APP_ID}&limit=100"
"https://crawler.algolia.com/api/1/crawlers?name=${ALGOLIA_CRAWLER_NAME}&itemsPerPage=100"
)"

crawler_id="$(
jq -er \
--arg crawler_name "${ALGOLIA_CRAWLER_NAME}" \
'.data[] | select(.name == $crawler_name) | .id' \
'.items[0].id' \
<<<"${response}"
)"

details="$(
curl --silent --show-error --fail \
--user "${ALGOLIA_CRAWLER_USER_ID}:${ALGOLIA_CRAWLER_API_KEY}" \
"https://crawler.algolia.com/api/1/crawlers/${crawler_id}"
)"

crawler_status="$(
jq -er \
--arg crawler_name "${ALGOLIA_CRAWLER_NAME}" \
'.data[] | select(.name == $crawler_name) | .status' \
<<<"${response}"
'if .blocked then "blocked"
elif .reindexing then "reindexing"
elif .running then "running"
else "paused"
end' \
<<<"${details}"
)"

echo "crawler_id=${crawler_id}" >> "${GITHUB_OUTPUT}"
Expand All @@ -85,17 +93,17 @@ jobs:
--user "${ALGOLIA_CRAWLER_USER_ID}:${ALGOLIA_CRAWLER_API_KEY}" \
--request POST \
--header "content-type: application/json" \
"https://crawler.algolia.com/api/user_configs/${{ steps.resolve.outputs.crawler_id }}/reindex"
"https://crawler.algolia.com/api/1/crawlers/${{ steps.resolve.outputs.crawler_id }}/reindex"
)"

action_id="$(
task_id="$(
jq -er \
'.data[] | select(.name == "reindex") | .id' \
'.taskId' \
<<<"${response}"
)"

echo "action_id=${action_id}" >> "${GITHUB_OUTPUT}"
echo "Queued Algolia reindex action ${action_id} for crawler ${ALGOLIA_CRAWLER_NAME}."
echo "task_id=${task_id}" >> "${GITHUB_OUTPUT}"
echo "Queued Algolia reindex task ${task_id} for crawler ${ALGOLIA_CRAWLER_NAME}."

- name: Confirm crawler entered reindexing state
env:
Expand All @@ -108,21 +116,23 @@ jobs:
response="$(
curl --silent --show-error --fail \
--user "${ALGOLIA_CRAWLER_USER_ID}:${ALGOLIA_CRAWLER_API_KEY}" \
"https://crawler.algolia.com/api/user_configs?appId=${ALGOLIA_APP_ID}&limit=100"
"https://crawler.algolia.com/api/1/crawlers/${{ steps.resolve.outputs.crawler_id }}"
)"

reindexing="$(
jq -er \
--arg crawler_name "${ALGOLIA_CRAWLER_NAME}" \
'.data[] | select(.name == $crawler_name) | .reindexing' \
'.reindexing' \
<<<"${response}"
)"

if [ "${reindexing}" = "true" ]; then
status="$(
jq -er \
--arg crawler_name "${ALGOLIA_CRAWLER_NAME}" \
'.data[] | select(.name == $crawler_name) | .status' \
'if .blocked then "blocked"
elif .reindexing then "reindexing"
elif .running then "running"
else "paused"
end' \
<<<"${response}"
)"

Expand Down
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,11 @@ Additional project scripts:

The docs search index is refreshed by the GitHub Actions workflow at [`.github/workflows/algolia-reindex.yml`](.github/workflows/algolia-reindex.yml).

That workflow matches the Algolia dashboard flow for this site:
That workflow matches the current Algolia Crawler API flow for this site:

* It looks up crawler `unraid` in Algolia app `JUYLFQHE7W`
* It triggers `POST https://crawler.algolia.com/api/user_configs/<crawler_id>/reindex`
* It looks up crawler `unraid` with `GET https://crawler.algolia.com/api/1/crawlers?name=unraid`
* It checks crawler details with `GET https://crawler.algolia.com/api/1/crawlers/<crawler_id>`
* It triggers `POST https://crawler.algolia.com/api/1/crawlers/<crawler_id>/reindex`

The workflow runs automatically on `main` when published docs content changes, and it can also be started manually with **Actions > Algolia Reindex > Run workflow**.

Expand Down
Loading