https://github.com/razonyang/hugo-theme-bootstrap-algolia-action

HBS Algolia GitHub Action
https://github.com/razonyang/hugo-theme-bootstrap-algolia-action

Last synced: about 1 month ago
JSON representation

HBS Algolia GitHub Action

• Host: GitHub
• URL: https://github.com/razonyang/hugo-theme-bootstrap-algolia-action
• Owner: razonyang
• License: mit
• Created: 2022-11-27T04:31:05.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-29T12:56:22.000Z (almost 2 years ago)
• Last Synced: 2024-05-22T15:33:37.008Z (6 months ago)
• Language: Shell
• Homepage:
• Size: 2.93 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HBS Algolia GitHub Action

Build and upload the Algolia index for the [HBS](https://github.com/razonyang/hugo-theme-bootstrap) theme.

## Usage

> Example: https://github.com/razonyang/blog/blob/main/.github/workflows/algolia.yml

Create the `.github/workflows/algolia.yml` under your site root with following content.

```yaml

name: Algolia Index

on:

  workflow_dispatch:

  push:

    branches:

      - "main"

jobs:

  index:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Build & upload Algolia index

        uses: razonyang/hugo-theme-bootstrap-algolia-action@[version]

        with:

          algolia-app-id: ${{ secrets.ALGOLIA_APP_ID }}

          algolia-api-key: ${{ secrets.ALGOLIA_API_KEY }}

          algolia-index-name: prod

```

1. Change the `algolia-index-name` as necessary.

1. Replace the `[version]`.

1. And then create the `ALGOLIA_APP_ID` and `ALGOLIA_APP_KEY` secrets for your repository.

Now the Algolia index will be built and uploaded automatically on `git push`.