ankane / setup-elasticsearch

The missing action for Elasticsearch

setup-elasticsearch

The missing action for Elasticsearch 🎉

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

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: 8

Supports major versions (8, 7), minor versions (8.5, 7.17, etc), and full versions (8.5.0, 7.17.7, etc)

Test against multiple versions

    strategy:
      matrix:
        elasticsearch-version: [8, 7]
    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@v3
        with:
          path: ~/elasticsearch
          key: ${{ runner.os }}-elasticsearch-${{ matrix.elasticsearch-version }}

Related Actions

• setup-postgres
• setup-mysql
• setup-mariadb
• setup-mongodb
• setup-sqlserver

Contributing

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

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features