Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shogo82148/actions-setup-redis
Setup Redis database Action
https://github.com/shogo82148/actions-setup-redis
database github-actions redis
Last synced: 19 days ago
JSON representation
Setup Redis database Action
- Host: GitHub
- URL: https://github.com/shogo82148/actions-setup-redis
- Owner: shogo82148
- License: mit
- Created: 2019-10-05T05:00:37.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T13:35:39.000Z (22 days ago)
- Last Synced: 2024-10-24T15:41:00.976Z (22 days ago)
- Topics: database, github-actions, redis
- Language: TypeScript
- Size: 5.08 MB
- Stars: 36
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# actions-setup-redis
This action sets by [redis](https://redis.io/) database for use in actions by:
- optionally downloading and caching a version of redis
- start redis-server
## Motivation
- GitHub Actions supports Docker services, and there is the official [redis image](https://hub.docker.com/_/redis). but it works on only Linux.
- Some test utils for redis (such as [Test::RedisServer](https://metacpan.org/pod/Test::RedisServer)) requires redis-server installed on the local host.
## Usage
See [action.yml](action.yml)
Basic:
```yaml
steps:
- uses: actions/checkout@v4
- uses: shogo82148/actions-setup-redis@v1
with:
redis-version: "7.x"
- run: redis-cli ping
```
Matrix Testing:
```yaml
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- "ubuntu-latest"
- "macOS-latest"
# - 'windows-latest' # windows is currently not supported.
redis:
- "7.2"
- "7.0"
- "6.2"
- "6.0"
- "5.0"
- "4.0"
name: Redis ${{ matrix.redis }} on ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Setup redis
uses: shogo82148/actions-setup-redis@v1
with:
redis-version: ${{ matrix.redis }}
auto-start: "false"
- name: tests with Test::RedisServer
run: |
cpanm Test::RedisServer
prove -lv t
```
## Configuration
### distribution
The distribution. The valid values are `redis` or `valkey`. The default value is `redis`.
You can use `redis-` and `valkey-` prefixes in `redis-version` instead of the `distribution` input.
For example, the following two workflows install Valkey 7.2.
```yaml
- uses: shogo82148/actions-setup-redis@v1
with:
distribution: "valkey"
redis-version: "7.2"
```
```yaml
- uses: shogo82148/actions-setup-redis@v1
with:
redis-version: "valkey-7.2"
```
### redis-version
The version of Redis.
The `redis-version` input supports the following syntax:
- `latest`: the latest version of stable Redis
- `7`, `6`, `5`, `4`: major versions
- `7.2`, `7.0`: minor versions
- `7.2.0`, `7.2.1`: patch versions
The default value is `latest`.
The actions supports only stable versions.
### redis-port
The port number that `redis-server` listens.
The default value is `6379`.
### redis-tls-port
The port number that `redis-server` listens TLS connections.
The default value is `0` and TLS is disabled.
### auto-start
If the `auto-start` is `true`, the action starts `redis-server` as a daemon.
If it is `false`, the action just install Redis commands, doesn't start `redis-server`.
It is a boolean value, valid values are `true` or `false`.
The default value is `true`.
### redis-conf
Extra configurations for `redis.conf`.
See [Redis configuration](https://redis.io/topics/config).
## Outputs
### redis-port
The port number that `redis-server` listens.
```yaml
jobs:
build:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v4
- id: setup
uses: shogo82148/actions-setup-redis@v1
# connect to the redis-server via TCP
- run: |
redis-cli -h 127.0.0.1 -p ${{ steps.setup.outputs.redis-port }} ping
```
### redis-unix-socket
The unix domain socket path that `redis-server` listens.
```yaml
jobs:
build:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v4
- id: setup
uses: shogo82148/actions-setup-redis@v1
# connect to the redis-server via unix domain socket
- run: |
redis-cli -s ${{ steps.setup.outputs.redis-unix-socket }} ping
```
### redis-tls-port
The port number that `redis-server` listens TLS connections.
### redis-tls-port
The directory path for TLS sample certificates/keys.
```yaml
jobs:
build:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v4
- id: setup
uses: shogo82148/actions-setup-redis@v1
with:
# TLS Support starts from v6.0.
redis-version: "6.0"
# TLS is disabled by default. You need extra configurations.
redis-port: "0"
redis-tls-port: "6379"
# connect to the redis-server via TLS
- run: |
redis-cli -h 127.0.0.1 -p "${{ steps.setup.outputs.redis-tls-port }}" \
--tls \
--cert "${{ steps.setup.outputs.redis-tls-dir }}/redis.crt" \
--key "${{ steps.setup.outputs.redis-tls-dir }}/redis.key" \
--cacert "${{ steps.setup.outputs.redis-tls-dir }}/ca.crt" \
ping
```
See [TLS Support](https://redis.io/topics/encryption) for more details.
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)