From 8e4255e2c108b92a6096159e5b05ed346dfbbea0 Mon Sep 17 00:00:00 2001 From: Moritz Schauer Date: Wed, 20 Oct 2021 09:45:24 +0200 Subject: [PATCH 1/4] Advice for transition --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 71fa5cf83..f20d104e0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![codecov.io](http://codecov.io/github/JuliaGraphs/Graphs.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaGraphs/Graphs.jl?branch=master) [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliagraphs.org/Graphs.jl/dev/) -**Project Status:** The Graphs project is a reboot of the now-archived LightGraphs +## Current Project Status + +The Graphs project is a reboot of the now-archived LightGraphs package, which remains available on GitHub at [sbromberger/LightGraphs.jl](https://github.com/sbromberger/LightGraphs.jl). If you don't need any new features developed since the fork, you can continue to @@ -15,6 +17,18 @@ this repository, but the current code base is unrelated to the old Graphs code and is derived purely from LightGraphs. To access the history of the old Graphs code, you can start from [commit 9a25019](https://github.com/JuliaGraphs/Graphs.jl/commit/9a2501948053f60c630caf9d4fb257e689629041). +**Transition from LightGraphs to Graphs:** + +LightGraphs and Graphs are functionally identical, still there are some steps involved making the change: + +* Change LG to Graphs in your Project.toml +* Update your using/imports +* Update your type constraints +* Increment your version number (Following SEMVER we suggest a patch release when no graph related functionality is made available through the API, otherwise a major release) +* Tag a release + +## Overview + Graphs offers both (a) a set of simple, concrete graph implementations -- `Graph` (for undirected graphs) and `DiGraph` (for directed graphs), and (b) an API for the development of more sophisticated graph implementations under the `AbstractGraph` From 20a2e2ff112f3a82d22f861f9cb09fb21d0dddf8 Mon Sep 17 00:00:00 2001 From: Moritz Schauer Date: Fri, 22 Oct 2021 10:00:39 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f20d104e0..d99e2025e 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ you can start from [commit 9a25019](https://github.com/JuliaGraphs/Graphs.jl/com LightGraphs and Graphs are functionally identical, still there are some steps involved making the change: -* Change LG to Graphs in your Project.toml +* Change `LightGraphs = "093fc24a-ae57-5d10-9952-331d41423f4d"` to `Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"` in your Project.toml. * Update your using/imports * Update your type constraints * Increment your version number (Following SEMVER we suggest a patch release when no graph related functionality is made available through the API, otherwise a major release) From 5d816c5841ea80c2cd385961e3210db79c2029c5 Mon Sep 17 00:00:00 2001 From: Moritz Schauer Date: Fri, 22 Oct 2021 10:00:46 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d99e2025e..7e9480a95 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ LightGraphs and Graphs are functionally identical, still there are some steps in * Change `LightGraphs = "093fc24a-ae57-5d10-9952-331d41423f4d"` to `Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"` in your Project.toml. * Update your using/imports * Update your type constraints -* Increment your version number (Following SEMVER we suggest a patch release when no graph related functionality is made available through the API, otherwise a major release) +* Increment your version number. Following semantic versioning, we suggest a patch release when no graphs or other `Graphs.jl`-objects can be passed through the API of your package by those depending on it, otherwise a major release. "Passed through" entails created outside and consumed inside your package and vice versa. * Tag a release ## Overview From 14f12e234218d60119fdb91ef077a04a0b6ae708 Mon Sep 17 00:00:00 2001 From: Moritz Schauer Date: Fri, 22 Oct 2021 13:31:54 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7e9480a95..19a05d8aa 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ you can start from [commit 9a25019](https://github.com/JuliaGraphs/Graphs.jl/com LightGraphs and Graphs are functionally identical, still there are some steps involved making the change: * Change `LightGraphs = "093fc24a-ae57-5d10-9952-331d41423f4d"` to `Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"` in your Project.toml. -* Update your using/imports -* Update your type constraints -* Increment your version number. Following semantic versioning, we suggest a patch release when no graphs or other `Graphs.jl`-objects can be passed through the API of your package by those depending on it, otherwise a major release. "Passed through" entails created outside and consumed inside your package and vice versa. -* Tag a release +* Update your `using` and `import` statements. +* Update your type constraints and other references to `LightGraphs` to `Graphs`. +* Increment your version number. Following semantic versioning, we suggest a patch release when no graphs or other `Graphs.jl`-objects can be passed through the API of your package by those depending on it, otherwise consider it a breaking release. "Passed through" entails created outside and consumed inside your package and vice versa. +* Tag a release. ## Overview