Skip to content

Commit

Permalink
Modify for merging upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
sebamarynissen committed Feb 1, 2024
1 parent 93d1348 commit 64b50ac
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 51 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Run Test
on: [push, workflow_dispatch]

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Git checkout
uses: actions/checkout@v4

- name: Use Node.js
uses: actions/setup-node@v4

- name: Cache node modules
uses: actions/cache@v4
env:
cache-name: cache-node-modules
with:
# npm cache files are stored in `~/.npm` on Linux/macOS
path: ~/.npm
key: ${{ runner.os }}-build-agenda-${{ hashFiles('**/package-lock.lock') }}
restore-keys: |
${{ runner.os }}-build-agenda-
- name: Update npm
run: npm -g install npm@latest

- name: Install Packages
run: npm install

- name: Docs
run: npm run docs
34 changes: 0 additions & 34 deletions .github/workflows/npm-publish.yml

This file was deleted.

13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
**DISCLAIMER**: I **do not** intend to actively maintain this repository.
I forked it from https://github.com/hokify/agenda because I desperately needed support for [mongodb@6](https://www.npmjs.com/package/mongodb) for my website www.whisthub.com.
Ideally this gets merged back eventually into [@hokify/agenda](https://github.com/hokify/agenda), or even better in [agenda/agenda](https://github.com/agenda/agenda).

However, I *do* intend to keep this up to date with the latest version of the [mongodb](https://www.npmjs.com/package/mongodb) package, but that's all.
Agenda is a great library and I would hate to see it dying because new mongodb versions are not supported.

Key differences with the [original repo](https://github.com/hokify/agenda) are:

- MongoDB is now a peer dependency, so it must be installed separately.
- The module is now [esm only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). This is to prepare for any of the dependencies - most notably `mongodb` - becoming esm-only one day too. It also helps push the ecosystem forward.
- The library is only tested against `mongodb@6`, but it should work for version 5 and even 4.

# Agenda

<p align="center">
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@whisthub/agenda",
"version": "0.0.0",
"name": "@hokify/agenda",
"version": "6.3.0",
"type": "module",
"description": "Light weight job scheduler for Node.js",
"exports": "./dist/index.js",
Expand Down Expand Up @@ -46,10 +46,10 @@
"scheduler",
"runner"
],
"author": "Sebastiaan Marynissen <info@whisthub.com>",
"author": "Simon Tretter <simon.tretter@hokify.com>",
"license": "MIT",
"bugs": {
"url": "https://github.com/whisthub/agenda/issues"
"url": "https://github.com/hokify/agenda/issues"
},
"dependencies": {
"cron-parser": "^4",
Expand Down

0 comments on commit 64b50ac

Please sign in to comment.