Generate action documentation and automatically publish to wiki

.github/workflows/check-generate-docs.yaml

@@ -0,0 +1,46 @@
+name: Documentation check
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  checkdocs:
+    name: Verify generated
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'true'
+
+      - name: Set up GO
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.23
+
+      - name: Cache go modules
+        id: cache-go
+        uses: actions/cache@v3
+        env:
+          cache-name: dependency-cache-1.23
+        with:
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Generate docs
+        run: |
+          go generate
+
+      - name: Verify nothing to generate
+        run: |
+          if [[ "$(git diff --name-only -- generatedocs/generated/documentation.go)" != "" ]]; then
+            echo "documentation not generated"
+            exit 1
+          fi

.github/workflows/publishwiki.yaml

@@ -0,0 +1,79 @@
+name: Publish wiki
+
+on:
+  workflow_dispatch:
+  push:
+      branches:
+        - "master"
+jobs:
+  generatewiki:
+    name: Generate WIKI
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: 'true'
+
+    - name: Set up GO
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.23
+
+    - name: Cache go modules
+      id: cache-go
+      uses: actions/cache@v3
+      env:
+        cache-name: dependency-cache-1.23
+      with:
+        path: |
+          ~/.cache/go-build
+          ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Generate wiki
+      run: |
+        make genwiki PARAM=--verbose
+
+    - name: Publish if any changes
+      env:
+        GIT_USER_EMAIL: ${{ secrets.PERBOT_EMAIL }}
+        GIT_USER_NAME: ${{ secrets.PERBOT_USERNAME }}
+      run: |
+        git status
+        cd gopherciser.wiki
+        if [[ "$(git diff --name-only)" != "" ]]; then
+          git status
+          echo "publishing wiki"
+          set -e
+          git config user.email "$GIT_USER_EMAIL"
+          git config user.name "$GIT_USER_NAME"
+          git commit -a -m "Github action automatically generated wiki"
+          git push
+        else
+          echo "no changes skipping publish"
+        fi
+
+    - name: Update submodule and generated go file in branch
+      env:
+        GIT_USER_EMAIL: ${{ secrets.PERBOT_EMAIL }}
+        GIT_USER_NAME: ${{ secrets.PERBOT_USERNAME }}
+      run: |
+        pwd
+        git status
+        if [[ "$(git diff --name-only)" != "" ]]; then
+          echo "add generated documentation and wiki sha to branch"
+          set -e
+          git config user.email "$GIT_USER_EMAIL"
+          git config user.name "$GIT_USER_NAME"
+          git add generatedocs/generated/documentation.go
+          git add gopherciser.wiki
+          git status
+          git commit -m "Github action automatically added generated documentation"
+          git push
+        else
+          echo "nothing to add"
+        fi

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gopherciser.wiki"]
+	path = gopherciser.wiki
+	url = [email protected]:qlik-oss/gopherciser.wiki.git

Makefile

@@ -16,6 +16,7 @@ ifeq ($(UNAME_S),Darwin)
 	OSFLAG += ./$(BIN)/$(BIN_NAME)_osx
 endif
 endif
+PARAM ?=
 
 .PHONY: clean build unit-test-cover unit-test-cover-ext codeclimate lint test alltests
 
@@ -63,3 +64,14 @@ alltests:
 
 # Run quickbuild test and linting. Good to run e.g. before pushing to remote
 verify: quickbuild test lint-min
+
+# init submodule and get latest version
+initwiki:
+	git submodule update --init --recursive --remote
+	git submodule foreach --recursive git checkout master
+
+# generate config and action documenation
+genwiki: initwiki
+	set -e
+	go generate
+	go run ./generatedocs/cmd/generatemarkdown $(PARAM) --wiki ./gopherciser.wiki

README.md

@@ -8,11 +8,29 @@ Gopherciser is used for load testing (that is, stress testing and performance me
 
 Gopherciser can run standalone, but is also included in the Qlik Sense Enterprise Scalability Tools (QSEST), which are available for download [here](https://community.qlik.com/t5/Qlik-Scalability/Qlik-Sense-Enterprise-Scalability-Tools/gpm-p/1579916).
 
-More information on Gopherciser is available here:
+For more information on how to perform load testing with Gopherciser see the [wiki](https://github.com/qlik-oss/gopherciser/wiki/introduction), this readme documents building and development of gopherciser.
 
-* [Load testing - an introduction](./docs/README.md)
-* [Setting up load scenarios](./docs/settingup.md)
-* [Architecture and code structure](./architecture.md)
+## Cloning repo
+
+This repo contains the wiki as a submodule, to clone sub modules when cloning the project 
+
+```bash
+git clone --recurse-submodules [email protected]:qlik-oss/gopherciser.wiki.git
+```
+
+If repo was cloned manually, the wiki submodule can be checked out using
+
+```bash
+git submodule update --init --recursive
+```
+
+Updating submodule to version defined by current branch commit:
+
+```bash
+git submodule update
+```
+
+**Note**  the submodule will by default be in it's `master` branch. Any changes done and pushed in the submodule master branch will instantly update the wiki (i.e. don't make changes intended for a PR directly here).
 
 ## Building Gopherciser
 
@@ -40,9 +58,17 @@ If you use Git Bash, but do not have `make.exe` installed, do the following to i
 #### Building the documentation
 
 The documentation can be generated from json with:
+
 ```bash
 go generate
 ```
+
+To generate wiki run
+
+```bash
+make genwiki
+```
+
 For more information, see [Generating Gopherciser documentation](./generatedocs/README.md).
 
 ### Build commands