Merge pull request #70 from jinnoflife/chore/updateInformations

[noticket] Add information about node version

.github/workflows/test_examples.yml

@@ -37,13 +37,16 @@ jobs:
       - uses: cachix/cachix-action@v12
         with:
           name: devenv
+      - name: Install direnv
+        run: sudo apt update && sudo apt install direnv
       - name: Install devenv.sh
         run: nix profile install --accept-flake-config tarball+https://install.devenv.sh/${DEVENV_VERSION}
         shell: sh
       - name: Test ${{ matrix.manifest }} example
         run: |
-          echo running on branch ${GITHUB_REF_NAME}
-          cd examples/${{ matrix.manifest }}
-          sed -i "s,kellerkinderDE/devenv-shopware?ref=v1.0.0,kellerkinderDE/devenv-shopware?ref=${GITHUB_REF_NAME}," devenv.yaml
+          cd ${GITHUB_WORKSPACE}/examples/${{ matrix.manifest }}
+          sed -i "s,kellerkinderDE/devenv-shopware?ref=v1.0.0,${GITHUB_REPOSITORY}?ref=${GITHUB_REF_NAME}," devenv.yaml
+          echo running on ${GITHUB_REPOSITORY} with ref ${GITHUB_REF_NAME}
+          direnv allow && direnv reload
           devenv ci -vvv
           devenv shell echo ok

README.md

@@ -1,6 +1,6 @@
 # Kellerkinder devenv
 [![GitHub Release](https://img.shields.io/github/v/release/kellerkinderDE/devenv-shopware.svg?style=flat)](https://github.com/kellerkinderDE/devenv-shopware/releases)
-[![Example tests](https://github.com/kellerkinderDE/devenv-shopware/actions/workflows/test_examples.yml/badge.svg)](https://github.com/kellerkinderDE/devenv-shopware/actions/workflows/test_examples.yml)
+[![Tests](https://github.com/kellerkinderDE/devenv-shopware/actions/workflows/test_examples.yml/badge.svg)](https://github.com/kellerkinderDE/devenv-shopware/actions/workflows/test_examples.yml)
 
 devenv provides a reproducible and declarative local development environment for our [Shopware](https://www.shopware.com) projects.
 It uses the [Nix package system](https://nixos.org/) to provide native packages for all our required services. This environment is
@@ -17,6 +17,9 @@ tightly tailored to the needs of our team members working on various projects wi
 ## Setup & Usage
 A description about the setup and usage can be found in the [Wiki](https://github.com/kellerkinderDE/devenv-shopware/wiki).
 
+### Update
+To update your devenv config to the latest version, simply follow the update instructions for the new version in the [Wiki](https://github.com/kellerkinderDE/devenv-shopware/wiki/Update)
+
 ## More Information:
 - https://devenv.sh/
 - https://developer.shopware.com/docs/guides/installation/devenv

docs/Options.md

@@ -7,7 +7,7 @@ kellerkinder.phpVersion = "php80";
 ```
 
 # kellerkinder.systemConfig
-Define shopware systemconfig values.
+Define shopware system config values.
 
 *_Example_*
 ```

docs/Update.md

@@ -1,7 +1,7 @@
 # Updates
 
 ## v1.0.0
-* You have to remove `http`, `https` and the ports (eg. `8000`) from `kellerkinder.additionalServerAlias`
+* You have to remove `http`, `https` and the ports (e.g. `8000`) from `kellerkinder.additionalServerAlias`
 * You have to adjust your `devenv.yaml` to
   ```yml
     ...
@@ -10,3 +10,4 @@
       flake: false
     ...
   ```
+* If your shopware version is below `6.5.x` you might want to add `languages.javascript.package = pkgs.nodejs-16_x;` to your `devenv.nix` due to compatibility.

examples/sw6/.envrc

@@ -1,3 +1,3 @@
 source_url "https://raw.githubusercontent.com/cachix/devenv/d1f7b48e35e6dee421cfd0f51481d17f77586997/direnvrc" "sha256-YBzqskFZxmNb3kYVoKD9ZixoPXJh1C9ZvTLGFRkauZ0="
 
-use devenv
+use devenv