Skip to content

Commit

Permalink
Adding in the favicon for the website and publishing (#744)
Browse files Browse the repository at this point in the history
* adding in the favicon for the website and publishing

* adding in gitignore to docs

* updating locations

* adding in workflow dispatch

* updating sqlite

* moving to syncronous
  • Loading branch information
jaredwray authored Aug 5, 2024
1 parent 268012d commit 0433c32
Show file tree
Hide file tree
Showing 18 changed files with 74 additions and 979 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
**Please check if the PR fulfills these requirements**
- [ ] Followed the [Contributing](https://github.com/jaredwray/cache-manager/blob/main/CONTRIBUTING.md) guidelines.
- [ ] Followed the [Contributing](https://github.com/jaredwray/cacheable/blob/main/CONTRIBUTING.md) guidelines.
- [ ] Tests for the changes have been added (for bug fixes/features) with 100% code coverage.
- [ ] Docs have been added / updated (for bug fixes / features)

Expand Down
47 changes: 47 additions & 0 deletions .github/workflows/deploy-website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: deploy-website

on:
workflow_dispatch:
push:
branches: [ main ]
release:
types: [released]

jobs:
setup-build-deploy:
name: Deploy Website
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20]

steps:
- name: Checkout
uses: actions/checkout@v4

# Test
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}

- name: Install PNPM
run: npm install -g pnpm

- name: Install Modules
run: pnpm install

- name: Build Website
run: pnpm build

- name: Publish to Cloudflare Pages
uses: cloudflare/pages-action@1
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: b09b24c345713c704e71dea8bd81f713
projectName: cacheableorg
branch: main
directory: packages/website/dist
gitHubToken: ${{ secrets.GH_TOKEN }}
wranglerVersion: '3'
1 change: 1 addition & 0 deletions .github/workflows/test.yml → .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: tests

on:
workflow_dispatch:
push:
branches: [ main ]
pull_request:
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,7 @@ out
.eslintcache
dist
yarn.lock
pnpm-lock.yaml
pnpm-lock.yaml
!packages/website/site/docs/index.md
packages/website/site/docs/*.md
packages/cacheable-request/test/testdb.sqlite
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"version": "1.0.0",
"description": "Cacheable Mono Repo",
"scripts": {
"test": "pnpm recursive run test",
"test:ci": "c8 --reporter=lcov pnpm recursive run test:ci",
"test": "pnpm -r --workspace-concurrency 1 test",
"test:ci": "c8 --reporter=lcov pnpm -r --workspace-concurrency 1 test:ci",
"test:services:start": "docker compose up -d",
"test:services:stop": "docker compose down",
"build": "pnpm recursive run build",
Expand Down
8 changes: 4 additions & 4 deletions packages/cache-manager-ioredis-yet/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Redis store for node cache manager

[![codecov](https://codecov.io/gh/jaredwray/cache-manager/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cache-manager)
[![tests](https://github.com/jaredwray/cache-manager/actions/workflows/test.yml/badge.svg)](https://github.com/jaredwray/cache-manager/actions/workflows/test.yml)
[![license](https://img.shields.io/github/license/jaredwray/cache-manager)](https://github.com/jaredwray/cache-manager/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/jaredwray/cacheable/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cacheable
[![tests](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml/badge.svg)](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml)
[![license](https://img.shields.io/github/license/jaredwray/cacheable)](https://github.com/jaredwray/cacheable/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/dm/cache-manager-ioredis-yet)](https://npmjs.com/package/cache-manager-ioredis-yet)
![npm](https://img.shields.io/npm/v/cache-manager-ioredis-yet)

Redis cache store for [node-cache-manager](https://github.com/jaredwray/cache-manager).
Redis cache store for [node-cache-manager](https://github.com/jaredwray/cacheable).

## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/cache-manager-ioredis-yet/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"types": "dist/index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/jaredwray/cache-manager.git"
"url": "https://github.com/jaredwray/cacheable.git"
},
"files": [
"dist",
Expand Down
8 changes: 4 additions & 4 deletions packages/cache-manager-redis-yet/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Redis store for node cache manager

[![codecov](https://codecov.io/gh/jaredwray/cache-manager/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cache-manager)
[![tests](https://github.com/jaredwray/cache-manager/actions/workflows/test.yml/badge.svg)](https://github.com/jaredwray/cache-manager/actions/workflows/test.yml)
[![license](https://img.shields.io/github/license/jaredwray/cache-manager)](https://github.com/jaredwray/cache-manager/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/jaredwray/cacheable/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cacheable)
[![tests](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml/badge.svg)](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml)
[![license](https://img.shields.io/github/license/jaredwray/cacheable)](https://github.com/jaredwray/cacheable/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/dm/cache-manager-redis-yet)](https://npmjs.com/package/cache-manager-redis-yet)
![npm](https://img.shields.io/npm/v/cache-manager-redis-yet)

Redis cache store for [cache-manager](https://github.com/jaredwray/cache-manager).
Redis cache store for [cache-manager](https://github.com/jaredwray/cacheable/tree/main/packages/cache-manager.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/cache-manager-redis-yet/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"types": "dist/index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/jaredwray/cache-manager.git"
"url": "https://github.com/jaredwray/cacheable.git"
},
"scripts": {
"build": "rimraf ./dist && tsc -p tsconfig.build.json",
Expand Down
16 changes: 8 additions & 8 deletions packages/cache-manager/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[<img align="center" src="https://jaredwray.com/images/cacheable_white.svg" alt="keyv">](https://github.com/jaredwray/cacheable)

# cache-manager
[![codecov](https://codecov.io/gh/jaredwray/cache-manager/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cache-manager)
[![tests](https://github.com/jaredwray/cache-manager/actions/workflows/test.yml/badge.svg)](https://github.com/jaredwray/cache-manager/actions/workflows/test.yml)
[![license](https://img.shields.io/github/license/jaredwray/cache-manager)](https://github.com/jaredwray/cache-manager/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/jaredwray/cacheable/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cacheable)
[![tests](https://github.com/jaredwray/cacheable/actions/workflows/test.yml/badge.svg)](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml)
[![license](https://img.shields.io/github/license/jaredwray/cacheable)](https://github.com/jaredwray/cacheable/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/dm/cache-manager)](https://npmjs.com/package/cache-manager)
![npm](https://img.shields.io/npm/v/cache-manager)

Expand Down Expand Up @@ -94,9 +94,9 @@ await memoryCache.store.mdel('foo', 'foo2');

You can use your own custom store by creating one with the same API as the built-in memory stores.

- [Example Custom Store lru-cache](https://github.com/jaredwray/cache-manager/blob/main/packages/cache-manager/src/stores/memory.ts)
- [Example Custom Store redis](https://github.com/jaredwray/cache-manager/tree/main/packages/cache-manager-redis-yet)
- [Example Custom Store ioredis](https://github.com/jaredwray/cache-manager/tree/main/packages/cache-manager-ioredis-yet)
- [Example Custom Store lru-cache](https://github.com/jaredwray/cacheable/blob/main/packages/cache-manager/src/stores/memory.ts)
- [Example Custom Store redis](https://github.com/jaredwray/cacheable/tree/main/packages/cache-manager-redis-yet)
- [Example Custom Store ioredis](https://github.com/jaredwray/cacheable/tree/main/packages/cache-manager-ioredis-yet)

#### Create single cache store synchronously

Expand Down Expand Up @@ -305,9 +305,9 @@ app.listen(port, () => {

### Official and updated to last version

- [node-cache-manager-redis-yet](https://github.com/jaredwray/cache-manager/packages/cache-manager-redis-yet) (uses [node_redis](https://github.com/NodeRedis/node_redis))
- [node-cache-manager-redis-yet](https://github.com/jaredwray/cacheable/packages/cache-manager-redis-yet) (uses [node_redis](https://github.com/NodeRedis/node_redis))

- [node-cache-manager-ioredis-yet](https://github.com/jaredwray/cache-manager/packages/cache-manager-ioredis-yet) (uses [ioredis](https://github.com/luin/ioredis))
- [node-cache-manager-ioredis-yet](https://github.com/jaredwray/cacheable/packages/cache-manager-ioredis-yet) (uses [ioredis](https://github.com/luin/ioredis))

### Third party

Expand Down
2 changes: 1 addition & 1 deletion packages/cache-manager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/jaredwray/cache-manager.git"
"url": "https://github.com/jaredwray/cacheable.git"
},
"keywords": [
"cache",
Expand Down
Binary file removed packages/cacheable-request/test/testdb.sqlite
Binary file not shown.
26 changes: 0 additions & 26 deletions packages/website/site/docs/cache-manager-ioredis-yet.md

This file was deleted.

26 changes: 0 additions & 26 deletions packages/website/site/docs/cache-manager-redis-yet.md

This file was deleted.

Loading

0 comments on commit 0433c32

Please sign in to comment.