Skip to content

Commit

Permalink
docs: add migration from 4.x.x to 5.x.x documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thepiwo committed Nov 19, 2024
1 parent d95ddc3 commit ebba552
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 6 deletions.
1 change: 0 additions & 1 deletion .github/workflows/pre-check-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on: [push]

jobs:
pre-check-publish:

runs-on: ubuntu-latest

steps:
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
The additional parameter `--next` can be used to either initialize or update a project with changes for an upcoming hard-fork if available.
17 changes: 17 additions & 0 deletions docs/migration-from-4.x.x-to-5.x.x.md
Original file line number Diff line number Diff line change
@@ -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");`
6 changes: 3 additions & 3 deletions docs/next-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
- 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`
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit ebba552

Please sign in to comment.