Merge branch 'main' into feature/wikiRunnerCreateFile

Author: EduardKrieger

.github/workflows/syncDocs.yml

@@ -37,10 +37,9 @@ jobs:
           echo ">"
           git diff-index --quiet HEAD & git status -s
           echo "<"
-          echo "TO_BE_CANCELLED=$(if [[ $(git diff-index --quiet HEAD & git status -s) ]]; then echo "false"; else echo "true"; fi)" >> $GITHUB_ENV
-          echo "$TO_BE_CANCELLED"
+          echo "COMPILER_TO_BE_CANCELLED=$(if [[ $(git diff-index --quiet HEAD & git status -s) ]]; then echo "false"; else echo "true"; fi)" >> $GITHUB_ENV
+          echo "$COMPILER_TO_BE_CANCELLED"
       - name: Copy docs and consolidate links to ${REPO_TUTORIAL_DEST} Repository
-        if: ${{ env.TO_BE_CANCELLED == 'false' }}
         run: |
           cp -rf ${REPO_COMPILER_SOURCE}/documentation/* ${REPO_TUTORIAL_DEST}/
           cd ${REPO_TUTORIAL_DEST}
@@ -52,29 +51,30 @@ jobs:
           echo ">"
           git diff-index --quiet HEAD & git status -s
           echo "<"
-          echo "TO_BE_CANCELLED=$(if [[ $(git diff-index --quiet HEAD & git status -s) ]]; then echo "false"; else echo "true"; fi)" >> $GITHUB_ENV
-          echo "$TO_BE_CANCELLED"
+          echo "TUTORIAL_TO_BE_CANCELLED=$(if [[ $(git diff-index --quiet HEAD & git status -s) ]]; then echo "false"; else echo "true"; fi)" >> $GITHUB_ENV
+          echo "$TUTORIAL_TO_BE_CANCELLED"
       - name: setup git user
-        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        if: ${{ env.COMPILER_TO_BE_CANCELLED == 'false' || env.TUTORIAL_TO_BE_CANCELLED == 'false'}}
         run: |
           git config --global user.email ${BUILD_USER_EMAIL}
           git config --global user.name ${BUILD_USER}
       - name: Sync Wiki
-        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        if: ${{ env.COMPILER_TO_BE_CANCELLED == 'false' }}
         run: |
           cd ${REPO_COMPILER_DEST}
           git status
           git add .
           git commit -m "${REPO_COMPILER_SOURCE} documentation | GitHub Actions $GITHUB_WORKFLOW $GITHUB_RUN_NUMBER"
           git remote add origin-wiki "https://${BUILD_USER}:${BUILD_USER_PASSWD}@github.com/${ORG}/${REPO_COMPILER_DEST}.git"
-          git push origin-wiki main
+          git push origin-wiki master
       - name: Sync Wiki ${REPO_TUTORIAL_DEST} Repository
-        if: ${{ env.TO_BE_CANCELLED == 'false' }}
+        if: ${{ env.TUTORIAL_TO_BE_CANCELLED == 'false' }}
         run: |
           cd ${REPO_TUTORIAL_DEST}
+          git pull
           git status
           git add .
           git commit -m "${REPO_COMPILER_SOURCE} documentation | GitHub Actions $GITHUB_WORKFLOW $GITHUB_RUN_NUMBER"
           git remote add origin-wiki "https://${BUILD_USER}:${BUILD_USER_PASSWD}@github.com/${ORG}/${REPO_TUTORIAL_DEST}.git"
-          git push origin-wiki main
+          git push origin-wiki master
       

assertions/noException.ts

@@ -3,7 +3,7 @@ import { RunResult } from "../engine/run_result";
 export class NoException {
     public static run(result: RunResult): void {
         if(result.exceptions.length > 0) {
-            throw new Error("Unexpected exception.");
+            throw new Error("Unexpected exception: " + result.exceptions.join());
         }
     }
 }

documentation/Assertions.md

@@ -1,41 +1,41 @@
 ## Assertions
 The following assertions are already implemented:
-* directoryExist
-* directoryNotEmpty
-* fileExist
-* fileContains
-* noErrorCode
-* noException
-* repositoryIsClean
-* serverIsReachable
+* [directoryExist](#directoryExist)
+* [directoryNotEmpty](#directoryNotEmpty)
+* [fileExist](#fileExist)
+* [fileContains](#fileContains)
+* [noErrorCode](#noErrorCode)
+* [noException](#noExceptions)
+* [repositoryIsClean](#repositoryIsClean)
+* [serverIsReachable](#serverIsReachable)
 
 ***
 
-### directoryExist
+### directoryExist <a name="directoryExist"></a>
 #### description
 Checks if a given path leads to an existing directory.
 #### parameter
 1. Path as a string, which should lead to an existing directory.
 
 ***
 
-### directoryNotEmpty
+### directoryNotEmpty <a name="directoryNotEmpty"></a>
 #### description
 Checks if a given directory contain at least one file or subdirectory.
 #### parameter
 1. Path as a string of a directory.
 
 ***
 
-### fileExist
+### fileExist <a name="fileExist"></a>
 #### description
 Checks if a given path leads to an existing file.
 #### parameter
 1. Path as a string
 
 ***
 
-### fileContains
+### fileContains <a name="fileContains"></a>
 #### description
 Checks if content is included in a file
 #### parameter
@@ -44,31 +44,31 @@ Checks if content is included in a file
 
 ***
 
-### noErrorCode
+### noErrorCode <a name="noErrorCode"></a>
 #### description
 Checks if the given RunResult has an returnCode of 0 otherwise throwing Error.
 #### parameter
 1. RunResult
 
 ***
 
-### noException
+### noException <a name="noException"></a>
 #### description
 Checks if the given RunResult's exception Array is empty otherwise throwing Error.
 #### parameter
 1. RunResult
 
 ***
 
-### repositoryIsClean
+### repositoryIsClean <a name="repositoryIsClean"></a>
 #### description
 Checks if the given directory is a git repository and is clean, meaning there are no uncommited changes.
 #### parameter
 1. Path of a directory as a string.
 
 ***
 
-### serverIsReachable
+### serverIsReachable <a name="serverIsReachable"></a>
 #### description
 Checks if a server is available on localhost.
 #### parameter

documentation/Development.md

@@ -6,7 +6,7 @@ https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure
 
 ### How to create a playbook
 The playbooks for the tutorial-compiler are contained in the tutorials repository. There you will find a description of how to create your own playbook.
-https://github.com/devonfw-tutorials/tutorials/wiki/Development
+https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Tutorials
 
 ### How to create your own command
 To create a new command you can use in your playbooks, you have to implement a new function for this command in all runner class you want to support this command. If you want to use the command only in katacoda tutorials for example, you have to implement the function only in the katacoda runner class.