Deploy nicely formatted test results to github pages

[jangko]

stealing idea from https://github.com/status-im/nim-ws: nim-ws is using github pages to store it's automatically generated test report using this github action plugin.

- name: Deploy autobahn report.
        if: runner.os == 'macos' && matrix.target.cpu == 'amd64'
        uses: peaceiris/actions-gh-pages@v3
        with:
          personal_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./nim-ws/autobahn/reports/servers

and you can see the result here: https://status-im.github.io/nim-ws/

what we need is convert our markdown generator to produce something more suitable for display.

[jangko]

found this excellent report generator https://www.npmjs.com/package/mochawesome-report-generator we only need to generate mocha test report json file. and then the report generator will generate a nicely formatted html and then we can use the above gha to deploy the results.

[jangko]

this is the POC of peaceiris/actions-gh-pages combined with mochawesome-report-generator applied to nim-graphql can be viewed here https://status-im.github.io/nim-graphql/

time to polish it and make it more generic for everyone to use.