seidnerj/github-version-checker

:mag: Simple version checker working with GitHub releases and the GitHub API.

---

🚧 Notice 🚧

This project is being renamed to just version-checker as I plan to support other platforms than Github in the future.

---

version-checker

Simple version checker working with GitHub releases and the GitHub API.

Supported Node.js versions

>= 14

While versions below 14.x are not officially tested they might work anyway.

The build works on 12.x so usage should be safe.

Everything below 12.x is not guaranteed to work.

Is this ESM only?

No.

This module may be require'd (CommonJS) or imported (ESM).

I do not plan on making this an ESM only module in the near future.

Install

$ npm install @version-checker/core

Documentation

version-checker (axelrindle.github.io)

Contributing

Feel free to contribute to this project in any form. Just make sure to read the Code of Conduct.

Open an issue if there is anything you're having problems with.

Setup

First of all clone the git repository :)

$ git clone https://github.com/axelrindle/github-version-checker.git

and then install the dependencies

$ npm ci

By running npm ci instead of npm i it is ensured that the dependency tree is installed exactly as stated in the package-lock.json file. That guarantees the usage of identical dependency trees throughout development.

Working on the packages

1. Bootstrap the Lerna environment

$ npx lerna bootstrap

2. Do your changes on a seperate branch, e.g. feature/my-bug-fix

3. When done, run tests using the following command:

$ npx lerna run test

Contributing to the documentation

All documentation resided within the docs/ directory. Is is built upon Docusaurus and primarily written in Markdown.

Install dependencies using

$ npm ci

and start the development server by running

$ npm start

To produce a production build, run

$ npm run build

That produces a static site which can be served using

$ npm run serve

License

MIT