starred/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-30 23:40:40 +02:00
Code Issues 1.0k Packages Projects Releases 10 Wiki Activity

[PR #821] [MERGED] Add ability to view current version's changelog from within ABS #3430

New Issue
Closed
opened 2026-04-25 00:15:37 +02:00 by adam · 0 comments
adam commented 2026-04-25 00:15:37 +02:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/821
Author: @jmt-gh
Created: 7/9/2022
Status: ✅ Merged
Merged: 7/10/2022
Merged by: @advplyr

Base: master ← Head: whats_new_modal

📝 Commits (7)

  • 997e231 extract current version changelog information
  • 05afd12 add new changelog modal
  • b823a93 integrate modal to sidenavs
  • bf6e87d update formatting
  • a22ebb2 add style comments
  • 201f1bf Add marked package in static libs
  • 5dfd5c4 Remove marked dependency

📊 Changes

8 files changed (+17587 additions, -36 deletions)

View changed files

📝 client/components/app/ConfigSideNav.vue (+13 -3)
📝 client/components/app/SideRail.vue (+14 -6)
➕ client/components/modals/changelog/ViewModal.vue (+73 -0)
📝 client/package-lock.json (+17429 -26)
📝 client/package.json (+1 -0)
📝 client/plugins/version.js (+7 -1)
➕ client/static/libs/marked/LICENSE (+44 -0)
➕ client/static/libs/marked/index.js (+6 -0)

📄 Description

This PR adds in the ability to view the current running version's changelog directly within ABS. We were already grabbing this information to derive the latest version, so we just hook in to that to extract the changelog for the current running version. There is a future enhancement here if we want it, to prompt this modal to the user once upon the first time they log in for a new version.

I noticed a few, what felt like at first glance, slightly different variants in our modal implementations, so I mimiced the RSSFeedModal since it was relatively new.

New Package Added

Name Marked
Number of dependencies: 0
Reason: The Github API returns the changelog in the raw Github Flavor Markdown that it was written in. Marked allows us to parse that to HTML, with explicit support for Github Flavor Markdown.

Screenshots (1920x1080)

Home screen
image
image

Config screen
image
image

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/advplyr/audiobookshelf/pull/821 **Author:** [@jmt-gh](https://github.com/jmt-gh) **Created:** 7/9/2022 **Status:** ✅ Merged **Merged:** 7/10/2022 **Merged by:** [@advplyr](https://github.com/advplyr) **Base:** `master` ← **Head:** `whats_new_modal` --- ### 📝 Commits (7) - [`997e231`](https://github.com/advplyr/audiobookshelf/commit/997e23150ef8359a80de6e2dcf6666e07946bc7c) extract current version changelog information - [`05afd12`](https://github.com/advplyr/audiobookshelf/commit/05afd12682381e22feaf508358e0363091927ead) add new changelog modal - [`b823a93`](https://github.com/advplyr/audiobookshelf/commit/b823a93ae2d1bc987df954684ee8caa401b60742) integrate modal to sidenavs - [`bf6e87d`](https://github.com/advplyr/audiobookshelf/commit/bf6e87d4bc2ef802a99ac97245bccbeea148cb47) update formatting - [`a22ebb2`](https://github.com/advplyr/audiobookshelf/commit/a22ebb257fea320a4974d33f6cf9f22d336987c4) add style comments - [`201f1bf`](https://github.com/advplyr/audiobookshelf/commit/201f1bff3e7800d65fe2b7551fbad6001e126045) Add marked package in static libs - [`5dfd5c4`](https://github.com/advplyr/audiobookshelf/commit/5dfd5c4971b540353dfa216336447f2b2ab2a0b6) Remove marked dependency ### 📊 Changes **8 files changed** (+17587 additions, -36 deletions) <details> <summary>View changed files</summary> 📝 `client/components/app/ConfigSideNav.vue` (+13 -3) 📝 `client/components/app/SideRail.vue` (+14 -6) ➕ `client/components/modals/changelog/ViewModal.vue` (+73 -0) 📝 `client/package-lock.json` (+17429 -26) 📝 `client/package.json` (+1 -0) 📝 `client/plugins/version.js` (+7 -1) ➕ `client/static/libs/marked/LICENSE` (+44 -0) ➕ `client/static/libs/marked/index.js` (+6 -0) </details> ### 📄 Description This PR adds in the ability to view the current running version's changelog directly within ABS. We were already grabbing this information to derive the latest version, so we just hook in to that to extract the changelog for the current running version. There is a future enhancement here if we want it, to prompt this modal to the user once upon the first time they log in for a new version. I noticed a few, what felt like at first glance, slightly different variants in our modal implementations, so I mimiced the RSSFeedModal since it was relatively new. ### New Package Added **Name** [Marked](https://github.com/markedjs/marked) **Number of dependencies**: 0 **Reason**: The Github API returns the changelog in the raw [Github Flavor Markdown](https://github.github.com/gfm/) that it was written in. Marked allows us to parse that to HTML, with explicit support for Github Flavor Markdown. ### **Screenshots** (1920x1080) **Home screen** ![image](https://user-images.githubusercontent.com/13617455/178090164-d8a39e6c-9748-430a-a505-5897ce4dd3b7.png) ![image](https://user-images.githubusercontent.com/13617455/178090005-f86d57f8-fbb3-4f8b-afab-53169904945a.png) **Config screen** ![image](https://user-images.githubusercontent.com/13617455/178090173-14c0ce81-c40e-4809-9453-e95985c37cf9.png) ![image](https://user-images.githubusercontent.com/13617455/178090009-7fed01ba-06b4-44d7-a822-67e528d399bf.png) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:15:37 +02:00
adam closed this issue 2026-04-25 00:15:37 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
authentication
backlog
bug
chapter editor
config-issue
ebooks
encoding/embedding
enhancement
help wanted
listening sessions & progress
planned
possible plugin
progress sync
pull-request
Mirrored from GitHub Pull Request
 sorting/filtering/searching
unable to reproduce
upload
users & permissions
waiting
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#3430
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?