Added the changelog to the documentation (#15)

VitalyArt · Feb 18, 2024 · 93d3c54 · 93d3c54
1 parent 99f9291
commit 93d3c54
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -17,9 +17,10 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Build
+      - name: Setup Node
         uses: actions/setup-node@v4
 
+      # Building the project
       - run: npm ci
       - run: npm run docs:build
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# v3.0.1
+- Fixed the return type in `Entry::getCDTrack()`
+- New documentation on GitHub Pages
+- Added the changelog to the documentation
+
 # v3.0.0
 
 ### Compatibility-breaking changes:

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -29,6 +29,12 @@ module.exports = {
         collapsable: false,     // optional, defaults to true
         sidebarDepth: 1,        // optional, defaults to 1
       },
+      {
+        title: 'Changelog',
+        path: 'changelog.html', // optional, link of the title, which should be an absolute path and must exist
+        collapsable: false,     // optional, defaults to true
+        sidebarDepth: 1,        // optional, defaults to 1
+      },
     ]
   },
   home: true,

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+../CHANGELOG.md