diff --git a/README.md b/README.md index e9c7946..4769873 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,15 @@ This tutorial is structured in multiple sequential chapters. Be sure to read [Ap Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, propose any changes to this repository using Pull Requests. +### Markdownlint-cli + +This workspace will be checked by the [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) (there is also documented ho to install the tool) tool in the CI workflow automatically. +To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with: + +```sh +markdownlint **/*.md --fix +``` + ## License and Legal information Please read the [Legal information](LICENSE.md) diff --git a/apax.yml b/apax.yml index b85ad6f..5144a80 100644 --- a/apax.yml +++ b/apax.yml @@ -15,7 +15,7 @@ variables: APAX_BUILD_ARGS: - --debug devDependencies: - "@ax/sdk": 2311.0.1 + "@ax/sdk": 2405.0.0 dependencies: "@simatic-ax/io": 5.0.0 "@ax/system-timer": 6.0.94 diff --git a/doc/publishing-lib.md b/doc/publishing-lib.md index 9f903e3..e8c2091 100644 --- a/doc/publishing-lib.md +++ b/doc/publishing-lib.md @@ -56,8 +56,7 @@ When you want to publish your package in a repository that is inside an organiza The key file will be located in ~/.apax/apax.signkey in the home directory. ![debug](./doc/images/../../images/keypair.PNG) - - >Note the `apax pack`need the key to sign the package. + >Note the `apax pack`need the key to sign the package. 1. Users can enter your package scope and public key in the publicKeys section of their apax.yml to detect corruption or manipulation when installing packages. @@ -81,7 +80,6 @@ When you want to publish your package in a repository that is inside an organiza The version in the apax.yml will be changed - 1. now we're able to create the package with the command: ```cli @@ -92,11 +90,9 @@ When you want to publish your package in a repository that is inside an organiza >Tip: you can open the *.tgz file with any zip/unzip program - - ### Create package by scripts -With Apax, you're able to define some own scripts. In this example we create a script which create a package. By excute the command +With Apax, you're able to define some own scripts. In this example we create a script which create a package. By execute the command 1. Open the apax.yml