Home Original page

GitHub - ankane/setup-elasticsearch: The missing action for Elasticsearch

The missing action for Elasticsearch 🎉

  • Simpler than containers
  • Works on Linux, Mac, and Windows
  • Supports different versions

Build Status

Getting Started

Add it as a step to your workflow

      - uses: ankane/setup-elasticsearch@v1

Versions

Specify a version (defaults to the latest)

      - uses: ankane/setup-elasticsearch@v1
        with:
          elasticsearch-version: 9

Supports major versions (9, 8), minor versions (9.0, 8.18, etc), and full versions (9.0.0, 8.18.0, etc)

Test against multiple versions

    strategy:
      matrix:
        elasticsearch-version: [9, 8]
    steps:
      - uses: ankane/setup-elasticsearch@v1
        with:
          elasticsearch-version: ${{ matrix.elasticsearch-version }}

Options

Install plugins

      - uses: ankane/setup-elasticsearch@v1
        with:
          plugins: |
            analysis-kuromoji
            analysis-smartcn

Set elasticsearch.yml config

      - uses: ankane/setup-elasticsearch@v1
        with:
          config: |
            http.port: 9200

Caching [experimental]

Add a step to your workflow before the setup-elasticsearch one

      - uses: actions/cache@v5
        with:
          path: ~/elasticsearch
          key: ${{ runner.os }}-elasticsearch-${{ matrix.elasticsearch-version }}

Related Actions

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help: