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 af12cb6bd6eba2b68bf90545724f1495fd4797e8.
* Fixes review comments
* Specifies versions as strings instead of floats
---------
Co-authored-by: carner <icarners@gmail.com>
2023-05-31 16:22:55 +03:00
|
|
|
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:
|
2023-09-20 10:42:31 +03:00
|
|
|
go-version: [ "1.18", "1.19", "1.20", "1.21" ]
|
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 af12cb6bd6eba2b68bf90545724f1495fd4797e8.
* Fixes review comments
* Specifies versions as strings instead of floats
---------
Co-authored-by: carner <icarners@gmail.com>
2023-05-31 16:22:55 +03:00
|
|
|
|
|
|
|
steps:
|
|
|
|
- name: Set up ${{ matrix.go-version }}
|
2023-12-13 16:54:06 +03:00
|
|
|
uses: actions/setup-go@v5
|
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 af12cb6bd6eba2b68bf90545724f1495fd4797e8.
* Fixes review comments
* Specifies versions as strings instead of floats
---------
Co-authored-by: carner <icarners@gmail.com>
2023-05-31 16:22:55 +03:00
|
|
|
with:
|
|
|
|
go-version: ${{ matrix.go-version }}
|
|
|
|
|
|
|
|
- name: Checkout code
|
2023-09-20 10:41:10 +03:00
|
|
|
uses: actions/checkout@v4
|
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 af12cb6bd6eba2b68bf90545724f1495fd4797e8.
* Fixes review comments
* Specifies versions as strings instead of floats
---------
Co-authored-by: carner <icarners@gmail.com>
2023-05-31 16:22:55 +03:00
|
|
|
|
|
|
|
- name: Test doc examples
|
|
|
|
working-directory: ./doctests
|
2023-09-20 10:42:31 +03:00
|
|
|
run: go test
|