Skip to content
This repository was archived by the owner on Nov 27, 2024. It is now read-only.

jaredwray/cache-manager-stores

Repository files navigation

Cache Manager Redis and IoRedis Stores

This is a mono repo for the Cache Manager Redis and IoRedis stores. These are the legacy stores for v5 as we are now moving forward with Keyv for redis. This repo is a collection of packages that are used to store cache data in Redis and IoRedis. The packages are:

Package Version Downloads Description
cache-manager-redis-yet npm npm Redis storage adapter for cache-manager
cache-manager-ioredis-yet npm npm IORedis storage adapter for cache-manager.

How to Use the Cacheable Mono Repo

Open a Pull Request

You can contribute changes to this repo by opening a pull request:

  1. After forking this repository to your Git account, make the proposed changes on your forked branch.
  2. You will need docker installed and running on your machine. Once it is installed run pnpm test:services:start to start the services needed for testing.
  3. Run tests and linting locally.
    • Run pnpm i && pnpm test.
  4. Commit your changes and push them to your forked repository.
  5. Navigate to the main cache-manager-stores repository and select the Pull Requests tab.
  6. Click the New pull request button, then select the option "Compare across forks"
  7. Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
  8. Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
  9. Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
  10. Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the cacheable repository.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the Github documentation

Post an Issue

To post an issue, navigate to the "Issues" tab in the main repository, and then select "New Issue." Enter a clear title describing the issue, as well as a description containing additional relevant information. Also select the label that best describes your issue type. For a bug report, for example, create an issue with the label "bug." In the description field, Be sure to include replication steps, as well as any relevant error messages.

If you're reporting a security violation, be sure to check out the project's security policy.

Please also refer to our Code of Conduct for more information on how to report issues.

Ask a Question

To ask a question, create an issue with the label "question." In the issue description, include the related code and any context that can help us answer your question.

License

MIT © Jared Wray

About

Redis and IoRedis Legacy Stores for Cache-Manager

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published