mirror of
https://github.com/redis/go-redis.git
synced 2025-07-29 17:41:15 +03:00
Adds testable examples to be automatically pulled in redis.io docs (#2601)
* Adding examples
* Update readme
* Update Readme
* Remove unneeded lines. Added an examples.json file
* Update readme for examples
* More fixes
* Add example tags
* Update examples.json
* Rename
* Add another hide block
* Temporary test
* Add example id for lpush and lrange
* Update readme
* Update output text
* Improve examples
* Move examples test dir to doctests
* Add redis v7's ExpireAtNX, ExpireAtXX, ExpireAtGT, ExpireAtLT, PExpireNX, PExpireXX, PExpireGT, PExpireLT, PExpireAtNX, PExpireAtXX, PExpireAtGT, PExpireAtLT
feat: Add redis v7's NX, XX, GT, LT expireat, pexpire, pexpireat variants
* add tests for new commands
add tests to coverage for the new commands
* Adds github workflow to add docexamples tests. Flushes db before every test.
* Fixes broken workflow file
* Adds Igor’s suggestion of keeping the instructions for docexamples in one place
* Removes unneeded “Missing” section, because it was solved as a workflow
* Revert "add tests for new commands"
This reverts commit af12cb6bd6
.
* Fixes review comments
* Specifies versions as strings instead of floats
---------
Co-authored-by: carner <icarners@gmail.com>
This commit is contained in:
41
.github/workflows/doctests.yaml
vendored
Normal file
41
.github/workflows/doctests.yaml
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
name: Documentation Tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master, examples]
|
||||
pull_request:
|
||||
branches: [master, examples]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
doctests:
|
||||
name: doctests
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
services:
|
||||
redis-stack:
|
||||
image: redis/redis-stack-server:latest
|
||||
options: >-
|
||||
--health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
|
||||
ports:
|
||||
- 6379:6379
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
go-version: [ "1.18", "1.19", "1.20" ]
|
||||
|
||||
steps:
|
||||
- name: Set up ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v4
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Test doc examples
|
||||
working-directory: ./doctests
|
||||
run: go test
|
Reference in New Issue
Block a user