Skip to content
This repository was archived by the owner on Dec 19, 2025. It is now read-only.

Commit ef379c2

Browse files
committed
Add CHANGELOG.md
1 parent b4ec7b7 commit ef379c2

1 file changed

Lines changed: 86 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## Unreleased
8+
### Security
9+
10+
- Bump minimist from 1.2.5 to 1.2.6 (#10).
11+
12+
## 2.3.0 - 2022-03-18
13+
### Added
14+
15+
- An option to exclude pre-releases from the check. Currently only works with the REST API (#9).
16+
17+
### Removed
18+
19+
- Dropped support for Node.js below version 10.
20+
21+
## 2.2.0 - 2020-05-02
22+
### Added
23+
24+
- A new option `latestOnly` has been added: Setting it to `true` will only fetch the latest release.
25+
26+
### Removed
27+
28+
- The `reduceTraffic` option.
29+
30+
## 2.1.2 - 2019-06-15
31+
### Fixed
32+
33+
- ReferenceError: version is not defined (#6).
34+
35+
## 2.1.1 - 2019-06-08
36+
### Added
37+
38+
- Added an option `reduceTraffic` to decide whether the traffic should be reduced using [axelrindle/gvc-json-reduce](https://github.com/axelrindle/gvc-json-reduce).
39+
40+
### Changed
41+
42+
- The codebase has been migrated to plain JavaScript.
43+
44+
### Security
45+
46+
- Bump coffeescript from 1.12.7 to 2.3.2 (#5).
47+
48+
## 2.1.0 - 2018-09-25
49+
### Added
50+
51+
- Support GitHub's REST API again.
52+
53+
## 2.0.1 - 2018-05-01
54+
55+
Addendum to 2.0.0
56+
57+
Clean up 🥴
58+
59+
## 2.0.0 - 2018-05-01
60+
### Added
61+
62+
- Support for GitHub's GraphQL API.
63+
64+
### Changed
65+
66+
- The `options` object changed and requires using a [personal access token](https://blog.github.com/2013-05-16-personal-api-tokens/). See [here](https://github.com/axelrindle/github-version-checker#the-options-object).
67+
- The `callback` structure changed. I decided to apply a node convention called **Error-First** in which a callback function's first parameter is the `error`. See [here](https://github.com/axelrindle/github-version-checker#the-callback-function-optional).
68+
69+
## 1.2.0 - 2018-01-02
70+
### Changed
71+
72+
- Now using [semver](https://github.com/npm/node-semver) instead of [semver-compare](https://github.com/substack/semver-compare/)
73+
74+
## 1.1.0 - 2017-08-30
75+
### Added
76+
77+
- Added an option to fetch latest release only (excluding pre-releases) or all releases (including pre-releases).
78+
79+
## 1.0.1 - 2017-04-01
80+
### Fixed
81+
82+
- Fixed removing all dots from the remote version string.
83+
84+
## 1.0.0 - 2017-04-01
85+
86+
Initial release.

0 commit comments

Comments
 (0)