You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -24,12 +24,14 @@ To see all existing search-related issues and pull requests, visit [github.com/g
24
24
25
25
---
26
26
27
-
## How it works
27
+
## Production deploys
28
28
29
-
The search data is synced automatically using a [GitHub Actions workflow](.github/workflows/sync-algolia-search-indices.yml)that is triggered by pushes to the `main` branch. This process generates structured data for all pages on the site, compares that data to what's currently on Algolia, then adds, updates, or removes indices based on the diff of the local and remote data, being careful not to create duplicate records and avoiding any unnecessary (and costly) indexing operations.
29
+
A [GitHub Actions workflow](.github/workflows/sync-algolia-search-indices.yml) triggered by pushes to the `main` branch syncs the search data to Algolia. This process generates structured data for all pages on the site, compares that data to what's currently on Algolia, then adds, updates, or removes indices based on the diff of the local and remote data, being careful not to create duplicate records and avoiding any unnecessary (and costly) indexing operations.
30
30
31
31
The Actions workflow progress can be viewed (by GitHub employees) in the [Actions tab](https://github.com/github/docs/actions?query=workflow%3AAlgolia) of the repo.
32
32
33
+
Because the workflow runs after a branch is merged to `main`, there is a slight delay for search data updates to appear on the site.
34
+
33
35
## Manual sync from a checkout
34
36
35
37
It is also possible to manually sync the indices to Algolia from your local checkout of the repo, before your branch is merged to `main`.
@@ -64,7 +66,7 @@ You can set `VERSION` and `LANGUAGE` individually, too.
64
66
65
67
Substitute a currently supported version for `<PLAN@RELEASE>` and a currently supported two-letter language code for `<TWO-LETTER-CODE>`.
66
68
67
-
## Label-triggered workflow
69
+
## Label-triggered Actions workflow
68
70
69
71
Docs team members can use an Actions workflow on GHES release PRs by applying a label in this format:
70
72
```
@@ -80,11 +82,11 @@ Why do we need this? For our daily shipping needs, it's tolerable that search up
80
82
81
83
## Files
82
84
83
-
### GitHub Actions workflow files
85
+
### Actions workflow files
84
86
85
87
-[`.github/workflows/sync-algolia-search-indices.yml`](.github/workflows/sync-algolia-search-indices.yml) - Builds and syncs search indices whenever the `main` branch is pushed to (that is, on production deploys).
86
88
-[`.github/workflows/dry-run-sync-algolia-search-indices.yml`](.github/workflows/dry-run-sync-algolia-search-indices.yml) - This workflow can be run manually (via `workflow_dispatch`) to do a dry run build of all the indices. Useful for confirming that the indices can build without erroring out.
87
-
-[`.github/workflows/sync-single-english-algolia-index.yml`](.github/workflows/sync-single-english-algolia-index.yml) - This workflow is run when a label in the right format is applied to a PR. See "[Label-triggered workflow](#label-triggered-workflow)" for details.
89
+
-[`.github/workflows/sync-single-english-algolia-index.yml`](.github/workflows/sync-single-english-algolia-index.yml) - This workflow is run when a label in the right format is applied to a PR. See "[Label-triggered Actions workflow](#label-triggered-actions-workflow)" for details.
0 commit comments