JonasHiltl / openchangelog

Easy to configure & self hostable Changelog Website
https://openchangelog.com
GNU Affero General Public License v3.0
153 stars 9 forks source link

Full text search indexing #27

Open JonasHiltl opened 1 week ago

JonasHiltl commented 1 week ago

A nice feature would be full text search over all release notes of a changelog. This would allow users to easily find specific changes or features across different versions

Technical Challenges

Detecting changes in remote changelog files:

Proposed Solution

Use existing caching mechanism and update the search index when HTTP status 200 is returned. Skips update when status 304 (Not Modified) is returned. But what when local files are used, we don't cache the local files?

We can use Bleve a golang search library to use an in memory index or file backed index. Then we don't require any external services.