Move changelog to docs

axelrindle · axelrindle · commit 3764fd238920 · 2022-09-28T23:41:50.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/changelog/1/1.0.0.md b/docs/changelog/1/1.0.0.md
@@ -0,0 +1,5 @@
+# 1.0.0
+
+> Released on `2017-04-01`
+
+Initial release 🎉
diff --git a/docs/changelog/1/1.0.1.md b/docs/changelog/1/1.0.1.md
@@ -0,0 +1,7 @@
+# 1.0.1
+
+> Released on `2017-04-01`
+
+## Fixed
+
+- Fixed removing all dots from the remote version string.
diff --git a/docs/changelog/1/1.1.0.md b/docs/changelog/1/1.1.0.md
@@ -0,0 +1,7 @@
+# 1.1.0
+
+> Released on `2017-08-30`
+
+## Added
+
+- Added an option to fetch latest release only (excluding pre-releases) or all releases (including pre-releases).
diff --git a/docs/changelog/1/1.2.0.md b/docs/changelog/1/1.2.0.md
@@ -0,0 +1,7 @@
+# 1.2.0
+
+> Released on `2018-01-02`
+
+## Changed
+
+- Now using [semver](https://github.com/npm/node-semver) instead of [semver-compare](https://github.com/substack/semver-compare/)
diff --git a/docs/changelog/1/_category_.json b/docs/changelog/1/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Version 1",
+    "position": 3,
+    "link": {
+        "type": "generated-index",
+        "title": "v1 Changelogs"
+    }
+}
diff --git a/docs/changelog/2/2.0.0.md b/docs/changelog/2/2.0.0.md
@@ -0,0 +1,12 @@
+# 2.0.0
+
+> Released on `2018-05-01`
+
+## Added
+
+- Support for GitHub's GraphQL API.
+
+## Changed
+
+- 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).
+- 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).
diff --git a/docs/changelog/2/2.0.1.md b/docs/changelog/2/2.0.1.md
@@ -0,0 +1,7 @@
+# 2.0.1
+
+> Released on `2018-05-01`
+
+Addendum to 2.0.0
+
+Clean up 🥴
diff --git a/docs/changelog/2/2.1.0.md b/docs/changelog/2/2.1.0.md
@@ -0,0 +1,8 @@
+# 2.1.0
+
+> Released on `2018-09-25`
+
+
+## Added
+
+- Support GitHub's REST API again.
diff --git a/docs/changelog/2/2.1.1.md b/docs/changelog/2/2.1.1.md
@@ -0,0 +1,15 @@
+# 2.1.1
+
+> Released on `2019-06-08`
+
+## Added
+
+- Added an option `reduceTraffic` to decide whether the traffic should be reduced using [axelrindle/gvc-json-reduce](https://github.com/axelrindle/gvc-json-reduce).
+
+## Changed
+
+- The codebase has been migrated to plain JavaScript.
+
+## Security
+
+- Bump coffeescript from 1.12.7 to 2.3.2 (#5).
diff --git a/docs/changelog/2/2.1.2.md b/docs/changelog/2/2.1.2.md
@@ -0,0 +1,7 @@
+# 2.1.2
+
+> Released on `2019-06-15`
+
+## Fixed
+
+- ReferenceError: version is not defined (#6).
diff --git a/docs/changelog/2/2.2.0.md b/docs/changelog/2/2.2.0.md
@@ -0,0 +1,11 @@
+# 2.2.0
+
+> Released on `2020-05-02`
+
+## Added
+
+- A new option `latestOnly` has been added: Setting it to `true` will only fetch the latest release.
+
+## Removed
+
+- The `reduceTraffic` option.
diff --git a/docs/changelog/2/2.3.0.md b/docs/changelog/2/2.3.0.md
@@ -0,0 +1,11 @@
+# 2.3.0
+
+> Released on `2022-03-18`
+
+## Added
+
+- An option to exclude pre-releases from the check. Currently only works with the REST API (#9).
+
+## Removed
+
+- Dropped support for Node.js below version 10.
diff --git a/docs/changelog/2/_category_.json b/docs/changelog/2/_category_.json
@@ -0,0 +1,8 @@
+{
+    "label": "Version 2",
+    "position": 2,
+    "link": {
+        "type": "generated-index",
+        "title": "v2 Changelogs"
+    }
+}
diff --git a/docs/changelog/index.md b/docs/changelog/index.md
@@ -0,0 +1,20 @@
+---
+sidebar_position: 0
+sidebar_label: Start
+---
+
+# Changelog
+
+All notable changes to this project will be documented on these pages.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Types of changes
+
+- `Added` for new features.
+- `Changed` for changes in existing functionality.
+- `Deprecated` for soon-to-be removed features.
+- `Removed` for now removed features.
+- `Fixed` for any bug fixes.
+- `Security` in case of vulnerabilities.
diff --git a/docs/changelog/unreleased.md b/docs/changelog/unreleased.md
@@ -0,0 +1,8 @@
+---
+sidebar_position: 1
+---
+
+# Unreleased
+## Security
+
+-  Bump minimist from 1.2.5 to 1.2.6 (#10).
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -63,7 +63,25 @@ const config = {
             path: 'examples',
             routeBasePath: 'examples',
             sidebarPath: require.resolve('./sidebars.js'),
-            // ... other options
+        },
+    ],
+    [
+        '@docusaurus/plugin-content-docs',
+        {
+            id: 'changelog',
+            path: 'changelog',
+            routeBasePath: 'changelog',
+            sidebarPath: require.resolve('./sidebars.js'),
+            async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
+                const sidebarItems = await defaultSidebarItemsGenerator(args);
+                const result = sidebarItems.map((item) => {
+                    if (item.type === 'category') {
+                        return {...item, items: item.items.reverse()};
+                    }
+                    return item;
+                });
+                return result;
+              },
         },
     ],
   ],

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +# 1.0.0
++
 +> Released on `2017-04-01`
++
 +Initial release 🎉