Skip to content

Commit

Permalink
Write release notes for QuikGraph.Graphviz module.
Browse files Browse the repository at this point in the history
  • Loading branch information
KeRNeLith committed Jun 3, 2020
1 parent e84b374 commit 58839ed
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| **Quality** | [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=quikgraph&metric=alert_status)](https://sonarcloud.io/dashboard?id=quikgraph) |
| **Nugets** | [![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph) QuikGraph |
| | [![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph.Serialization) QuikGraph.Serialization |
| | [![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph.Graphviz) QuikGraph.Graphviz |
| **License** | MS-PL |

# QuikGraph
Expand All @@ -19,9 +20,9 @@ QuikGraph comes with algorithms such as depth first search, breath first search,

It was then updated to become YC.QuickGraph.

**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the Core of the library to provide it as a clean NuGet package using modern C# development (.NET Core).
**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the library to provide it as a clean NuGet packages using modern C# development (.NET Core).

The plan would be to fully clean the original library and all its non Core parts and unit test it more.
The plan is to to fully clean, fix issues of the original library and all its non Core parts, and improve it.

---

Expand Down Expand Up @@ -63,6 +64,7 @@ QuikGraph is available on [NuGet](https://www.nuget.org) in several modules.

- [QuikGraph](https://www.nuget.org/packages/QuikGraph) (Core)
- [QuikGraph.Serialization](https://www.nuget.org/packages/QuikGraph.Serialization)
- [QuikGraph.Graphviz](https://www.nuget.org/packages/QuikGraph.Graphviz)

### Where to go next?

Expand Down
27 changes: 26 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release notes

## What's new in 2.1.0 May 11 2020
## What's new in 2.1.0 May 11 2020 and June 3 2020

### QuikGraph

Expand All @@ -15,6 +15,31 @@
#### Fixes:
* Fix a security vulnerability regarding XML serialization on target .NET Framework 3.5.

### QuikGraph.GraphViz

Rework the original QuickGraph.Graphviz module into QuikGraph.Graphviz. This make possible to use the QuikGraph to Dot bridge.

#### Fixes:
* Fix the floating points formatting when converted to Dot (Invariant culture).
* Fix some implementation issues accross the library.
* Fix labels, comments, tooltips, records and ports escaping.
* Fix a lot of graph to Dot conversions issues (wrong properties, invalid formatting, typo, etc).

#### Updates:
* Add all color representations equivalent to System.Drawing.Color or System.Windows.Media.Color to GraphvizColor.

#### New:
* Add conversion extensions from System.Drawing.Font to GraphvizFont (and vice versa).

### API Breaks
* Dot escape method has been replaced by DotEscapers helpers that handle various escaping scenarios and are static.
* Some public API breaks (but should remain simple to do a migration).

#### Misc:
* Clean the library code.
* Fully document library including convenient links to official Graphviz documentation.
* Use JetBrains annotations all over the library as much as possible.

---

## What's new in 2.0.0 February 16 2020
Expand Down
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ QuikGraph comes with algorithms such as depth first search, breath first search,

It was then updated to become YC.QuickGraph.

**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the Core of the library to provide it as a clean NuGet package using modern C# development (.NET Core).
**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the library to provide it as a clean NuGet packages using modern C# development (.NET Core).

The plan would be to fully clean the original library and all its non Core parts and unit test it more.
The plan is to to fully clean, fix issues of the original library and all its non Core parts, and improve it.

You can find library sources on [GitHub](https://github.com/KeRNeLith/QuikGraph).

Expand All @@ -45,4 +45,8 @@ QuikGraph is available on [NuGet](https://www.nuget.org) in several modules.

PM> Install-Package QuikGraph.Serialization

[![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph.Graphviz) [QuikGraph.Graphviz](https://www.nuget.org/packages/QuikGraph.Graphviz)

PM> Install-Package QuikGraph.Graphviz

<img src="images/quikgraph_logo.png" width="128" height="128" style="display: block; margin-left: auto; margin-right: auto" />
22 changes: 21 additions & 1 deletion src/QuikGraph.Graphviz/QuikGraph.Graphviz.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,33 @@
This package is the Graphviz subset of the original QuickGraph renamed QuikGraph and ported to .NET Core.

Supported platforms:
- .NET Standard 1.3+
- .NET Core 1.0+
- .NET Framework 3.5+

Supports Source Link</Description>

<IsPackable>true</IsPackable>
<PackageId>QuikGraph.Graphviz</PackageId>
<PackageReleaseNotes>➟ Release 2.1.0</PackageReleaseNotes>
<PackageReleaseNotes>➟ Release 2.1.0
Rework the original QuickGraph.Graphviz module into QuikGraph.Graphviz. This make possible to use the QuikGraph to Dot bridge.

Fixes:
- Fix the floating points formatting when converted to Dot (Invariant culture).
- Fix some implementation issues accross the library.
- Fix labels, comments, tooltips, records and ports escaping.
- Fix a lot of graph to Dot conversions issues (wrong properties, invalid formatting, typo, etc).

Updates:
- Add all color representations equivalent to System.Drawing.Color or System.Windows.Media.Color to GraphvizColor.

New:
- Add conversion extensions from System.Drawing.Font to GraphvizFont (and vice versa).

Misc:
- Clean the library code.
- Fully document library including convenient links to official Graphviz documentation.
- Use JetBrains annotations all over the library as much as possible.</PackageReleaseNotes>
<PackageTags>QuickGraph QuikGraph Graph Structure Algorithm C# .NET Serialization Graphviz</PackageTags>
</PropertyGroup>

Expand Down

0 comments on commit 58839ed

Please sign in to comment.