Overview:

Octoclairvoyant is a web application that allows users to compare and analyze changelogs of different releases on GitHub repositories. It provides a more efficient and organized way to view code changes, making it easier to identify breaking changes and stay up to date with library updates. The app uses a parsing process to extract information from GitHub releases and normalize, group, and sort the changelogs for better readability. It also highlights code blocks and GitHub references for easier navigation and understanding.

Features:

• Search repositories and pick a version range: Users can search for specific repositories and choose a range of versions to compare.
• Sort and group releases’ changelogs following Semantic Versioning: Changelogs are organized and categorized according to Semantic Versioning standards.
• Share changelogs comparison with others: Users can share a link to the changelogs comparison with others.
• Normalize changes categories: Different types of changes, such as bug fixes and minor changes, are categorized and grouped together.
• Highlight code blocks syntax and GitHub references: Code blocks and references to GitHub are visually highlighted for better readability.
• Makes it easy to spot which version introduced specific changes: Users can easily identify which version introduced specific changes.
• Retrieve and parse releases descriptions from GitHub: The app retrieves all release descriptions from a repository and parses them using unified js to convert them into React elements.

Installation:

To install Octoclairvoyant, follow these steps:

1. Clone the repository:

git clone https://github.com/octoclairvoyant/octoclairvoyant.git

2. Change into the octoclairvoyant directory:

cd octoclairvoyant

3. Install the dependencies:

npm install

4. Start the application:

npm start

5. Access the application through your browser at http://localhost:3000.

Summary:

Octoclairvoyant is a web application designed to simplify the process of comparing and analyzing changelogs between different releases on GitHub repositories. It provides features such as the ability to search repositories, pick version ranges, and categorize changelogs. The app normalizes the changes categories and highlights code blocks and GitHub references for better readability. It retrieves release descriptions from GitHub, parses them using unified js, and converts them into React elements. Octoclairvoyant aims to make it easier for users to identify breaking changes and stay up to date with library updates.