From ebba552e4da2cb31a75d51cd5d5311b094229636 Mon Sep 17 00:00:00 2001
From: Philipp <github@piwo.space>
Date: Thu, 24 Aug 2023 14:19:48 +0200
Subject: [PATCH] docs: add migration from 4.x.x to 5.x.x documentation

---
 .github/workflows/pre-check-publish.yml |  1 -
 README.md                               |  1 +
 docs/cli/init.md                        |  4 ++--
 docs/migration-from-4.x.x-to-5.x.x.md   | 17 +++++++++++++++++
 docs/next-support.md                    |  6 +++---
 mkdocs.yml                              |  1 +
 6 files changed, 24 insertions(+), 6 deletions(-)
 create mode 100644 docs/migration-from-4.x.x-to-5.x.x.md

diff --git a/.github/workflows/pre-check-publish.yml b/.github/workflows/pre-check-publish.yml
index 19631448..eac42903 100644
--- a/.github/workflows/pre-check-publish.yml
+++ b/.github/workflows/pre-check-publish.yml
@@ -4,7 +4,6 @@ on: [push]
 
 jobs:
   pre-check-publish:
-
     runs-on: ubuntu-latest
 
     steps:
diff --git a/README.md b/README.md
index d0ab3f37..5964a1f3 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,7 @@ npm install -g @aeternity/aeproject
 - [Unit Testing](docs/cli/test.md)
 - [AEproject Library](docs/lib.md)
 - [Migration from 3.x.x to 4.x.x](docs/migration-from-3.x.x-to-4.x.x.md)
+- [Migration from 4.x.x to 5.x.x](docs/migration-from-4.x.x-to-5.x.x.md)
 - [Upcoming Version Support](docs/next-support.md)
 
 ## Release Process
diff --git a/docs/cli/init.md b/docs/cli/init.md
index 5e70bedd..6763cc28 100644
--- a/docs/cli/init.md
+++ b/docs/cli/init.md
@@ -10,7 +10,7 @@ Creates a new project structure with a few folders in which the developer can cr
 
 ## Update existing project
 
-For upgrade from old AEproject versions check out [Migration from 3.x.x to 4.x.x](../migration-from-3.x.x-to-4.x.x.md).
+For upgrade from old AEproject versions check out [Migration from 3.x.x to 4.x.x](../migration-from-3.x.x-to-4.x.x.md) and [Migration from 4.x.x to 5.x.x](../migration-from-4.x.x-to-5.x.x.md).
 
 ```text
 aeproject init --update
@@ -20,4 +20,4 @@ Updates the project structure and needed artifacts to the latest version, as wel
 
 ## Upcoming Hard-fork initialization
 
-The additional parameter `--next` can be used to either initialize or update a project with changes for an upcoming hard-fork if available.
\ No newline at end of file
+The additional parameter `--next` can be used to either initialize or update a project with changes for an upcoming hard-fork if available.
diff --git a/docs/migration-from-4.x.x-to-5.x.x.md b/docs/migration-from-4.x.x-to-5.x.x.md
new file mode 100644
index 00000000..6e99e2d9
--- /dev/null
+++ b/docs/migration-from-4.x.x-to-5.x.x.md
@@ -0,0 +1,17 @@
+# Migration from 4.x.x to 5.x.x
+
+## Changes
+
+**AEproject** `v5.0.0` underwent some minor but breaking changes.
+
+Install the new AEproject version
+
+```
+npm install -g @aeternity/aeproject
+```
+
+### Removed from libs
+
+Following utils have been removed and cannot be used anymore:
+
+- `utils.getFilesystem()` discontinued, as it is now natively available in the sdk via import, e.g. `const { getFileSystem } = require("@aeternity/aepp-sdk");`
diff --git a/docs/next-support.md b/docs/next-support.md
index 8bd5dd9a..d348386a 100644
--- a/docs/next-support.md
+++ b/docs/next-support.md
@@ -6,9 +6,9 @@ Aeproject can already be used for testing and setup with the upcoming node versi
 
 Use `aeproject init --next ` to initialize a new project that has the necessary adjustments to use the latest versions.
 
-Use `aeproject init --update --next` to update an existing project with the adjustments to use the latest versions. 
+Use `aeproject init --update --next` to update an existing project with the adjustments to use the latest versions.
 
 ### Manual update
 
- - change occurrences of `utils.getSdk()` to use `utils.getSdk({ ignoreVersion: true })` if needed or use the same option for manually initialized sdk `Node` and `CompilerHttp`
- - update `docker-compose.yml` to use the `latest` node and compiler tags or specify it manually in running with `aeproject env --nodeVersion latest --compilerVersion latest`
\ No newline at end of file
+- change occurrences of `utils.getSdk()` to use `utils.getSdk({ ignoreVersion: true })` if needed or use the same option for manually initialized sdk `Node` and `CompilerHttp`
+- update `docker-compose.yml` to use the `latest` node and compiler tags or specify it manually in running with `aeproject env --nodeVersion latest --compilerVersion latest`
diff --git a/mkdocs.yml b/mkdocs.yml
index 92c0a371..0beb3f45 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -47,4 +47,5 @@ nav:
   - cli/test.md
   - lib.md
   - migration-from-3.x.x-to-4.x.x.md
+  - migration-from-4.x.x-to-5.x.x.md
   - next-support.md