# Changelog

Change log contains all version updates, old, current and upcoming with all important additions, fixes or improvements. The **unchecked** items of the *work in progress* version, are the items remained before this build is released.

### \[Version 2.16] - 09 November 2024

{% hint style="info" %}
This version upgrades **MudBlazor** library version to the latest one, using the v7.0.0 migration [guide](https://github.com/MudBlazor/MudBlazor/issues/8447) which has multiple breaking changes. 
{% endhint %}

### \[Version 2.15] - 23 May 2024

{% hint style="info" %}
This version adds **PostgreSQL** support. You can now use **PostgreSQL** instead of **SQL Server.**\
Read release [2.15.0](https://github.com/chsakell/Harmony/releases/tag/v2.15.0) changes for more details on how to configure PostgreSQL.

[postgresql](https://chsakell.gitbook.io/harmony/configuration/dependencies/databases/postgresql "mention") guide explains what to do in order to use PostgreSQL as your main database provider.
{% endhint %}

* [x] Separate migrations projects per database provider.
* [x] Add [PostgreSQL](https://chsakell.gitbook.io/harmony/configuration/dependencies/databases/postgresql) guide.

### \[Version 2.14] - 19 May 2024

{% hint style="info" %}
**Harmony is now a public** [**repository**](https://github.com/chsakell/Harmony) **available for everyone** :tada:

This version's goal is to enhance board's operations performance :rocket: and more specifically loading a board & opening a card's view. 

Several caching options *(in memory, Redis, distributed, etc..)* will be supported using the [EasyCachin](https://github.com/dotnetcore/EasyCaching)[g](https://github.com/dotnetcore/EasyCaching) library.

Also, the dependency in the two stored procedures existing will be removed in order to add an option for [PostgreSQL](https://www.postgresql.org/) database. This way you will be able to use **PostgreSQL** instead of **SQL Server** :tada:
{% endhint %}

* [x] Fix a bug **(null reference exception)** occurring rarely in AutoMapper :warning:
* [x] Remove <mark style="color:red;">\[dbo].\[LoadBoard]</mark> & <mark style="color:red;">\[dbo].\[LoadBoardListCards]</mark> stored procedure dependencies.
* [x] Integrate EasyCaching library
  * [x] Implement **distributed caching** using **Redis** provider for board cards
  * [x] Implement local **in memory** caching for board cards

### \[Version 2.13] - 5 May 2024

* [x] Add a powerful **work-items** page for searching/filtering board's items
  * [x] Create new work-items page
  * [x] Filter items by list type (e.g. task, bug, etc..)
  * [x] Filter items by status (in progress, done, etc..)
  * [x] Filter items by active sprint (*scrum projects only*)
  * [x] Order items by date created, list type, status
* [x] Handle Git **tag** Webhook requests
* [x] Display only one active sprint at a time with the option to change selected active sprints

### \[Version 2.12] - 28 April 2024

{% hint style="info" %}
How about leveling up Harmony once again! :muscle::up:

This version's goal is to integrate **GitHub** directly to Harmony boards! :rocket:\
It would be great if you could link GitHub issues, branches, pull requests, etc.. with board items. GitHub will be the first source control integration, others will follow next. \
\
Read the [github](https://chsakell.gitbook.io/harmony/integrations/github "mention")integration guide to configure your source control settings.
{% endhint %}

* [x] Create new project **Harmony.Integrations.SourceControl** for handling GitHub webhooks
* [x] Handle **branch creation** webhook
* [x] Handle **push commits** webhook
* [x] Handle **pull request** *(created, closed, merged)* webhooks
* [x] Display card's repository activity on edit card modal
* [x] Create detailed card's repository activity view
* [x] Automatically sync card's repository activity when a GitHub webhook is triggered (no refresh is required) :rocket:
* [x] Add docker & Kubernetes support for the new project created

### \[Version 2.11] - 11 April 2024

{% hint style="info" %}
This version's goal is to support **issue linking** :link: between issues.&#x20;

The following link types will be supported:

* is blocked by / blocks

* is cloned by / clones

* is duplicated by / duplicates

* relates to
  {% endhint %}

* [x] Add link entity migration :link:

* [x] Add link to an issue :heavy\_plus\_sign:

* [x] Open linked issue to new tab

* [x] Remove a link from an issue :heavy\_minus\_sign:

* [x] Auto-sync linked cards upon linking/unlinking

* [x] Display link icon on board cards

### \[Version 2.10] - 4 April 2024 <a href="#version-2.10" id="version-2.10"></a>

{% hint style="info" %}
Time to level up Harmony once again! :up: This version's goal is to bring the first **retrospective** implementation! :tada:  :rocket:\
You will be able to create a retrospective for a specific sprint *(scrum projects)*  :muscle:

:bangbang: Please delete the harmony databases from your local environment to be recreated. There are some breaking changes.
{% endhint %}

* [x] Create Retrospective entity, entity configurations & migrations <mark style="color:red;">(</mark>*<mark style="color:red;">breaking</mark>*<mark style="color:red;">)</mark>
* [x] Create a retrospective for a sprint
* [x] View retrospective's board
* [x] Add cards to a retrospective card
* [x] Edit & archive a retrospective card

### \[Version 2.9] - 24 March 2024

* [x] Fix card filter specifications that affected several operations
* [x] Fix WebSocket re-connection issue on page reload
* [x] Fix sprints filtering query&#x20;

### \[Version 2.8] - 23 March 2024

* [x] Add support to create and optionally start a **new sprint** when moving items from backlog
* [x] Directly edit subtask **story points** from parent's issue edit modal view
* [x] Edit workspace details
* [x] Refactor sprints page
* [x] Create new individual sprint page
* [x] Position & card movement fixes

### \[Version 2.7] - 16 March 2024

{% hint style="info" %}
This version goal to do use Kubernetes **self-healing** functionality and for this to happen we need to implement health checks to Harmony microservices & add the required readiness & liveness probes.

As a bonus :sparkles:,  the **Sum up story points** automation will be implemented. This automation will sum up the story points of all sub-tasks and then update the parent issue with this value.
{% endhint %}

* [x] Add database health checks
* [x] Add RabbitMQ health checks
* [x] Add readiness & liveness probes in all microservices
* [x] Create the **Sum up story points** automation :rocket:
* [x] Archive workspace :wastebasket:

### \[Version 2.6] - 28 February 2024 <a href="#version-2.6" id="version-2.6"></a>

Added [Kubernetes](https://chsakell.gitbook.io/harmony/configuration/docker/kubernetes) support :rocket:

### \[Version 2.5] - 25 February 2024 <a href="#version-2.5" id="version-2.5"></a>

{% hint style="info" %}
This version goal is to introduce an <mark style="color:orange;">API Gateway</mark> so there's a **unified point of entry** into harmony system. For this, [Ocelot](https://github.com/ThreeMammals/Ocelot) Gateway will be used to:

* Proxy all requests starting with */core* to <mark style="color:blue;">Harmony.Api</mark>

* Proxy all requests starting with */automations* to <mark style="color:blue;">Harmony.Automations</mark>

* Proxy all WebSocket connections to <mark style="color:blue;">Harmony.Signalr</mark> through Gateway\
  \
  This way, the client only needs to know a single endpoint configuration, the gateway's endpoint. Also the gateway can be used for other reasons in the future, e.g. *caching, rate limiting, service discovery, tracing, load balancer, kubernetes*
  {% endhint %}

* [x] Create new project <mark style="color:blue;">Harmony.ApiGateway</mark>

* [x] Integrate <mark style="color:blue;">Harmony.Api</mark> to Gateway

* [x] Integrate <mark style="color:blue;">Harmony.Automations</mark> to Gateway

* [x] Integrate <mark style="color:blue;">Harmony.SignalR</mark> to Gateway

* [x] Dockerize <mark style="color:blue;">Harmony.ApiGateway</mark>

* [x] Add **distributed logging** using Elastic Search & Kibana :mag: :rocket:

### &#x20;\[Version 2.4] - 17 February 2024 <a href="#version-2.4" id="version-2.4"></a>

{% hint style="info" %}
This version's goal is to **containerize** Harmony solution :muscle:\
Docker files will be added for every web application in order to define their image build process. Next, a **docker-compose** file will be responsible to define the services and all of their dependencies *(SQL Server, Redis, MongoDB, etc..)*. \
Ideally after this release, you should be able to start Harmony by running the following commands:

```docker
docker compose build
docker compose up
```

{% endhint %}

* [x] Create *Dockerfile* for <mark style="color:blue;">Harmony.Api</mark>.
* [x] Create *Dockerfile* for <mark style="color:blue;">Harmony.SignalR</mark>.
* [x] Create *Dockerfile* for <mark style="color:blue;">Harmony.Client</mark>.
* [x] Create *Dockerfile* for <mark style="color:blue;">Harmony.Automations</mark>.
* [x] Create *Dockerfile* for <mark style="color:blue;">Harmony.Notifications</mark>.
* [x] Create **docker-compose** file to start Harmony with a single command.

<figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2FqlG2q1jUgybfTRBsgbf9%2Fharmony-containers.png?alt=media&#x26;token=66a92460-06a8-4172-a720-99892fdf0fe1" alt="" width="563"><figcaption></figcaption></figure>

### \[Version 2.3.1] - 12 February 2024

* Minor fixes on Image URLs

### \[Version 2.3] - 8 February 2024

{% hint style="info" %}
After working on architectural improvements for a few sprints in a row, it's high time to get back on track and start adding new features :tada:
{% endhint %}

* [x] Display <mark style="color:red;">archived</mark> cards.
* [x] <mark style="color:green;">Re-activate</mark> archived cards by moving them either to a board (Kanban) or to a sprint (Scrum).
* [x] Sync board across all connections upon card creation or archiving.
* [x] Implement **Smart auto-assign** automation.
* [x] Rename **Harmony.Notifications** HangFire database to **Harmony.Notification.Jobs** *(breaking - check databases & SQL Server sections)*.
* [x] Use a new **Harmony.Automations.Jobs** SQL Server database for HangFire jobs in <mark style="color:blue;">Harmony.Automations</mark>.

### \[Version 2.2] - 26 January 2024 <a href="#version-2.2" id="version-2.2"></a>

{% hint style="info" %}
This version's goal is to integrate [gRPC](https://learn.microsoft.com/en-us/aspnet/core/grpc/?view=aspnetcore-8.0) communication between internal microservices. This will finalize the solution design towards a **dockerized** microservice architecture.

* The only application that has direct access to the main harmony database is the <mark style="color:blue;">Harmony.Api</mark>.
* The only application that has direct access to the MongoDB automations database is the <mark style="color:blue;">Harmony.Automations</mark>.
* Any interaction between backend microservices should be done through high performant communication using **gRPC** framework :rocket:

\
\&#xNAN;***gRPC** is a modern open source high performance Remote Procedure Call (RPC) framework that can run in any environment. It can efficiently connect services in and across data centers with pluggable support for load balancing, tracing, health checking and authentication.*
{% endhint %}

* [x] Expose gRPC services from Harmony.Api.
* [x] Expose gRPC service from Harmony.Automations.
* [x] Remove direct harmony database access from <mark style="color:blue;">Harmony.Automations</mark> and consume gRPC service from Harmony.Api instead.
* [x] Remove direct harmony database access from <mark style="color:blue;">Harmony.Notifications</mark> and consume gRPC service from Harmony.Api instead.
* [x] Remove direct MongoDB database access from <mark style="color:blue;">Harmony.Api</mark> and consume gRPC service from Harmony.Automations instead.

### \[Version 2.1]  - 23 January 2024 <a href="#version-2.1" id="version-2.1"></a>

{% hint style="info" %}
This version will upgrade the entire solution to .NET 8.0 :rocket: :tada:
{% endhint %}

* [x] Upgrade solution projects to .NET 8.0
* [x] Convert <mark style="color:blue;">Harmony.Client</mark> to **Standalone Blazor WebAssembly** project.
* [x] Rename <mark style="color:blue;">Harmony.Server</mark> to **Harmony.API** *(microservice)*.
* [x] Rename Harmony.Server.SignalR to **Harmony.SignalR**.
* [x] Remove all MongoDB database dependencies/access from all projects except from Harmony.Automations *(Harmony.Automations will be a microservice)*.
* [x] Expose HTTP endpoints for internal microservice communication.

### \[Version 2.0] - 20 January 2024 <a href="#version-2.0" id="version-2.0"></a>

> The first rule of any technology used in a business is that **automation** applied to an efficient operation will magnify the efficiency. The second is that **automation** applied to an inefficient operation will magnify the inefficiency.
>
> [***Bill Gates***](#user-content-fn-1)[^1]

{% hint style="info" %}
This version will bring 3 major upgrades which will level up Harmony even more:

* Add the very first **automation**. The first automation template that will be implemented is the *"<mark style="color:orange;">Auto close parent issue when all sub-tasks are done</mark>".*
* Create a scalable **SignalR** web app responsible for pushing the board related updates to clients.  Another scaling issue to be solved.
  {% endhint %}

Version 2.0 will set things up towards a [**dockerized**](https://www.docker.com/) solution. Sit back and relax, this might take a while.

* [x] Add support for child issues to cards.
* [x] Change issue status from card's view.
* [x] Display total number of child issues per card on board.
* [x] Create [**Harmony.Automations**](https://chsakell.gitbook.io/harmony/guide/automations) project for handling automations.
* [x] Create Automations settings page.
* [x] Create, enable, disable and remove an automation.
* [x] Create [**Harmony.Server.SignalR**](https://chsakell.gitbook.io/harmony/configuration/dependencies/databases/redis) project for handling SignalR messages.

### \[Version 1.5] - 2 January 2024 <a href="#version-1.5" id="version-1.5"></a>

> *We are searching for some kind of **harmony** between two intangibles: a form which we have not yet designed and a context which we cannot properly describe.*\
> \
> [***Christopher Alexander***](#user-content-fn-2)[^2]

{% hint style="info" %}
This version's goal is to add a **powerful Search textbox** at the top bar :mag\_right: .  \
Here are some of the features to be implemented in this release:
{% endhint %}

#### Features

* [x] Integrate [Algolia](https://www.algolia.com/) search engine for super fast indexing & searching capabilities. Algolia is totally [free](https://www.algolia.com/pricing/) to use for **10000** requests per month  :muscle: and probably the easiest search engine to configure, existing at the moment
* [x] Implement a database fallback search service in case there's no search engine integration configuration
* [x] Add app bar search textbox for fast results
* [x] Create search modal option for advanced searching scenarios *(based on several criteria, e.g. issue status,  members assigned, board etc.)*&#x20;
* [x] Add **caching** to database operations

For more info on how to setup the search engine read the [search-engine](https://chsakell.gitbook.io/harmony/configuration/dependencies/search-engine "mention") docs.

{% hint style="info" %}
**Why Algolia & not Elastic Search?**<br>

* Algolia search is [faster](https://www.algolia.com/blog/engineering/full-text-search-in-your-database-algolia-versus-elasticsearch/), more relevant, and easier to use than Elasticsearch for searching simple database data. Algolia's focus is on getting exceptional results with minimal configuration.&#x20;
* Elasticsearch is more flexible for searching complex data and can be used for a wider range of search applications.
  {% endhint %}

### \[Version 1.4]  -  18 December 2023

{% hint style="info" %}
This version's goal is to add the first **charts** for monitoring a scrum project's progress :tada:. \
Also support for **adding comments** in cards will be added :speaking\_head:
{% endhint %}

#### Features

* [x] Create, edit, delete comments :writing\_hand::pencil:
* [x] Implement **story points** for issues
* [x] Add burndown chart report for scrum sprints :chart\_with\_upwards\_trend:
* [x] View card in **Fullscreen** :clap: :100:
* [x] Display number of comments on board
* [x] Update backlog item inline :muscle::clap:
* [x] Update sprint item inline :tada:

#### Fixes

* [x] Fix RabbitMQ configuration *(add username, password, virtual host)*
* [x] Fix validation issue on edit sprint modal
* [x] Load board query fixes for scrum projects

<figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2FUgfrBUtEtzMJHoNRdGVa%2Fburndown-report-dark.png?alt=media&#x26;token=6581d2f5-ae84-47a1-ae40-ec7ae23078b7" alt=""><figcaption></figcaption></figure>

<div><figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2F7BcI3pM4YgN1uBq992k5%2Fcard-comments.gif?alt=media&#x26;token=743c49bb-4a6b-4d73-aab3-9dcd3435729f" alt=""><figcaption><p>Comments &#x26; Fullscreen preview</p></figcaption></figure> <figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2F87HBs2TAXZ1ZXBMIVVom%2Fburndown-report-light.png?alt=media&#x26;token=0a6b58f0-f53e-4a76-ac15-415e5cd0e412" alt=""><figcaption></figcaption></figure> <figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2FQ1KNvG9Ekprm95bNO8k4%2Fissues-overview-light.png?alt=media&#x26;token=703ef2c9-90b2-4a94-b676-e17389faeedb" alt=""><figcaption></figcaption></figure> <figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2FIPcoPFIJNTe0Zm2GLYr3%2Fissues-overview-dark.png?alt=media&#x26;token=c9f0271e-e29f-4747-8758-10aa950542e1" alt=""><figcaption></figcaption></figure> <figure><img src="https://4051864592-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FS3EgJIfGPiZJAR9LaG%2Fuploads%2FCT9ShM2XwJDgxxxpf5hN%2Fsprint-table.png?alt=media&#x26;token=7c21d3ee-36c5-4555-bdbf-132462de6984" alt=""><figcaption></figcaption></figure></div>

### \[Version 1.3] - 6 December 2023

{% hint style="info" %}
This version's goal was to **add email notifications** using Gmail configuration and optional email service provider such as Brevo. For best practices and scaling capabilities, a new project was created, responsible to send the notifications. The entire setup will be based on **RabbitMQ** messaging & **HangFire**.

Other than that, there were **fixes** and an amazing UX improvement on the board level and specifically when **moving cards**. It became more responsive while it also syncs the board status across all connected members
{% endhint %}

* [x] **RabbitMQ** messaging integration
* [x] New **Harmony.Notifications** web application with **HangFire** integration for background jobs
* [x] Add **Gmail** integration for email notifications
* [x] &#x20;Add [Brevo](https://www.brevo.com/products/transactional-email/) integration for email notifications

#### UI changes

* [x] Add **due date reminder field** on card's date edit view *(e.g. 1 day before, 1 hour before, etc..)*
* [x] 3 default board lists are added for Kanban projects as well
* [x] Add user options for enabling/disabling notifications
* [x] UX board improvements

#### Notifications implemented so far

* [x] Member added to a workspace
* [x] Workspace access revoked from member
* [x] Member added to a board
* [x] Board access revoked from member
* [x] Issue completed *(moved to a list marked as DONE)*
* [x] Due date based on due date reminder type
* [x] Member assigned to card
* [x] Member has given access to board
* [x] Board access revoked

#### Fixes

* [x] Fixes for card movement in the board, especially with positioning
* [x] Fix typo error when building in **Release** mode
* [x] Ensure *Files* folder exists inside the published folder when publishing **Harmony.Server** web app

### \[Version 1.2] - 24 November 2023

* [x] Add support for Scrum Projects! :clap: :heart::rocket:
* [x] Create backlog
* [x] Create sprints
* [x] Start a sprint
* [x] Complete a sprint & move any pending items to backlog or a different sprint
* [x] Move items from sprint to backlog
* [x] Move items from backlog to sprints
* [x] Introduce issue types for cards *(Epic, Bug, Task, Story, Task)*
* [x] Create **Serial Key** to easily identify cards/issues, e.g. HARM-1[^3]
* [x] Create board/sprint navigation items *(left menu & breadcrumbs)*
* [x] Change backlog items order

#### Enhancements

* [x] Add remove button to remove attachments
* [x] Clear card's dates
* [x] Update user's profile picture in all user card's components after uploading a picture in account page
* [x] Update text on **Enter** key pressed on *EditableTextField* component
* [x] Display loader when creating cards
* [x] Scroll to the card's position added when creating a card within a list filled with multiple cards

### \[Version 1] - 14 November 2023

* [x] User registration / login
* [x] Create workspaces
* [x] Add users to workspaces
* [x] Create **KANBAN** boards
* [x] Add users to boards
* [x] Add lists to boards
* [x] Rename & reorder lists
* [x] Add cards to boards
* [x] Move cards
* [x] Assign users to cards
* [x] Add labels to cards
* [x] Toggle labels, add custom labels to board/cards
* [x] Add checklists to cards
* [x] Add check list items to checklists
* [x] Add start / due date to cards
* [x] Register some activities

#### Read next - Technology

{% content-ref url="technology" %}
[technology](https://chsakell.gitbook.io/harmony/overview/technology)
{% endcontent-ref %}

[^1]: William Henry Gates III (born October 28, 1955) is an American businessman, investor, philanthropist, and writer best known for co-founding the software giant [Microsoft](https://en.wikipedia.org/wiki/Microsoft)

[^2]: Christopher Wolfgang John Alexander (4 October 1936 – 17 March 2022) was an Austrian-born British-American architect and design theorist. He was an emeritus professor at the University of California, Berkeley. His theories about the nature of human-centered design have affected fields beyond architecture, including urban design, software, and sociology.

[^3]: First issue for a project named Harmony