Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brob/algolia-issue-search
https://github.com/brob/algolia-issue-search
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brob/algolia-issue-search
- Owner: brob
- License: mit
- Created: 2021-11-16T20:08:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T08:16:00.000Z (about 1 year ago)
- Last Synced: 2024-10-14T09:43:28.665Z (3 months ago)
- Language: JavaScript
- Size: 139 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A GitHub action to get "related" Issues from an Algolia Index.
## Usage
```yml
- id: search
name: Search based on issue title
uses: brob/[email protected]
with:
app_id: ${{ secrets.ALGOLIA_APP_ID }}
api_key: ${{ secrets.ALGOLIA_API_KEY }}
index_name: ${{ github.event.repository.name }}
issue_title: ${{ github.event.issue.title }}
```
### Action inputs
| Name | Description | Required |
| --- | --- | --- |
| `app_id` | ID of this application in your Algolia account (best stored in a Github Secret). | true |
| `api_key` | API key with search permissions to the index in your Algolia account (best stored in a Github Secret). | true |
| `index_name` | Name of the Algolia index to search. | true |
| `issue_title` | The title of the inciting Issue. This is used to search an Algolia Index. | true |
| `max_results` | A maximum number of results to display (default: 3) | false |
### Outputs
This Action outputs two variables: `issues_list` and `comment_body`. Both return Markdown.
#### issues_list
```markdown
* [Issue Title](issue.url)
* [Issue Title](issue.url)
* [Issue Title](issue.url)
```
#### `comment_body`
```markdown
## Other issues similar to this one:
* [Issue title](issue.url)
```
## License
[MIT](LICENSE)