{"id":29020384,"url":"https://github.com/appbaseio/pipelines-template","last_synced_at":"2026-04-22T23:35:15.203Z","repository":{"id":37078976,"uuid":"464796419","full_name":"appbaseio/pipelines-template","owner":"appbaseio","description":"Template repo to get started with ReactiveSearch Pipelines Action","archived":false,"fork":false,"pushed_at":"2023-09-26T05:41:30.000Z","size":363,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-26T01:05:31.880Z","etag":null,"topics":["action","pipelines","reactivesearch","reactivesearch-api","template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appbaseio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-03-01T07:56:25.000Z","updated_at":"2022-12-02T04:48:57.000Z","dependencies_parsed_at":"2025-06-26T01:05:33.669Z","dependency_job_id":"a023c8b6-8630-4bf6-ab22-deea99576228","html_url":"https://github.com/appbaseio/pipelines-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/appbaseio/pipelines-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fpipelines-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fpipelines-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fpipelines-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fpipelines-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appbaseio","download_url":"https://codeload.github.com/appbaseio/pipelines-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Fpipelines-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32159959,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T17:06:48.269Z","status":"ssl_error","status_checked_at":"2026-04-22T17:06:19.037Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["action","pipelines","reactivesearch","reactivesearch-api","template"],"created_at":"2025-06-26T01:05:30.181Z","updated_at":"2026-04-22T23:35:15.188Z","avatar_url":"https://github.com/appbaseio.png","language":"JavaScript","readme":"# ReactiveSearch Pipelines Templates\n\nThis repo acts as a _get started_ template repo for the end user that just wants to get their hands dirty with ReactiveSearch Pipelines.\n\n### \\[[What are Pipelines?](#what-are-pipelines)] \\[[Pipelines Provided](#pipelines-provided)] \\[[Prerequisites](#prerequisites)] \\[[Utility Scripts](#utility-scripts)] \n\n## What are Pipelines?\n\n**TL;DR**\n\n- Pipelines lets the user define how a route, when hit, should behave.\n- Pipelines consist of a set of stages executed in an order (as defined by the user).\n- Pipelines allows using predefined stages using the `use` keyword and custom stages using a `.js` file passed by either the `script` or `scriptRef` field.\n\n---\n\nPipelines are user defined files that gets invoked by one or more routes (defined during creation). When invoked, these pipelines just follow a set of stages (in an user defined order). Pipelines gives the end user to craft custom endpoints according to their needs on top of the _pre-built_ stages provided.\n\nPipeline Stages consists of two types:\n\n### Pre Defined Stages\n\nThese are stages defined by the API and these can be directly utilized in a certain stage by using the `use` keyword.\n\nFor eg: If we want to use a predefined stage that to enforce passing credentials in the pipeline route invocation, we can use the `authorization` stage in the following way:\n\n```yaml\n- id: Authorize the request\n  uses: authorization\n```\n\n### Custom Stages\n\nCustom stages can also be executed in the pipeline by defining them in the stage. A custom stage should be **JavaScript** code that will get executed. This _chunk_ of `JS` code can be passed in a stage using either the `script` or the `scriptRef` key.\n\n- The `script` key is a string which consists of the JS code. This is essentially **_inline_** JS code.\n- The `scriptRef` key is a path to a `.js` file that contains the JS code.\n\nFor eg: If we want to use a custom stage that `console.log()`'s the request body passed by the user, we can do that in the following way:\n\n```js\nconsole.log(JSON.stringify(context.request.body));\n```\n\n\u003e NOTE: We are stringify'ing the body because an object is just printed as `object Object`\n\nLet's say below file is named `log.js` and is in the same directory that the `pipeline.yaml` file is in, we can define a stage in the following way:\n\n```yaml\n- id: Console Log request body\n  scriptRef: \"log.js\"\n```\n\nOR, if we want to pass the JS _inline_, we can do that in the following way:\n\n```yaml\n- id: Console Log request body\n  script: \"console.log(JSON.stringify(context.request.body));\"\n```\n\n## Pipelines Provided\n\nFollowing pipeline examples are provided in this template.\n\nTo use any of the pipeline provided, just the `file` path needs to be changed in the action yaml: `./github/workflow/action.yaml`\n\n| Name                                                                                           | Description                                                                                                                                                                                           | File Path                         |\n| ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |\n| [Basic Pipeline](https://github.com/appbaseio/pipelines-template/tree/master/basic)            | This pipeline mocks reactivesearch by defining three basic steps, `authorization`, `reactivesearchQuery` and `elasticsearchQuery` along with a custom modify request script that modifies the request | `./basic/pipeline.yaml`           |\n| [Knowledge Graph](https://github.com/appbaseio/pipelines-template/tree/master/knowledge_graph) | This pipeline fetches data from Google's Knowledge graph and merges it with the ES response data                                                                                                      | `./knowledge_graph/pipeline.yaml` |\n| [Saved Search](https://github.com/appbaseio/pipelines-template/tree/master/saved_search)       | This pipeline is similar to the basic pipeline with an extra step that saves the search to an user preferred index                                                                                    | `./saved_search/pipeline.yaml`    |\n| [Http Request](https://github.com/appbaseio/pipelines-template/tree/master/http_request) | This pipeline shows how the `httpRequest` stage can be used to simplify the pipeline | `./http_request/pipeline.yaml` |\n| [Query Rules](https://github.com/appbaseio/pipelines-template/tree/master/query_rules) | This pipeline shows how to use query rules pre-built stages | `./query_rules/pipeline.yaml` |\n| [Cache \u0026 Analytics](https://github.com/appbaseio/pipelines-template/tree/master/cache_analytics) | This pipeline shows how to use caching and record analytics for search queries | `./cache_analytics/pipeline.yaml` |\n| [Solr](https://github.com/appbaseio/pipelines-template/tree/master/solr) | This pipeline shows how a relevant search endpoint is made to work with Solr | `./solr/pipeline.yaml` |\n| [Solr Validate](https://github.com/appbaseio/pipelines-template/tree/master/solr_validate) | This pipeline shows how a validate endpoint can be provided for Solr | `./solr_validate/pipeline.yaml` |\n| [MongoDB](https://github.com/appbaseio/pipelines-template/tree/master/mongodb) | Pipeline to show how MongoDB can be used as a search backend | `./mongodb/pipeline.yaml` |\n| [Vector Indexing](https://github.com/appbaseio/pipelines-template/tree/master/vector_indexing) | Pipeline to show how indexing pipeline can be overridden to support indexing vector data | `./vector_indexing/pipeline.yaml` |\n| [kNN Search](https://github.com/appbaseio/pipelines-template/tree/master/knn_search) | Pipeline to show how kNN search can be done | `./knn_search/pipeline.yaml` |\n\n## Prerequisites\n\n- Appbase.io URL will have to be saved as a secret in GitHub secrets with the keyword `APPBASEIOURL`. This URL is required by the action to deploy the pipeline. [Read more about setting GitHub Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)\n\n## Utility Scripts\n\nBesides the pipeline templates, this repo also contains some useful utility scripts for testing the pipelines and generating `one-click` version of the pipeline by automatically resolving dependencies. [More can be read about them over here](./.scripts/README.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Fpipelines-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappbaseio%2Fpipelines-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Fpipelines-template/lists"}