Merge pull request #1 from kadena-io/ci-build

Fix GitHub CI build for ubuntu-20.04

.github/workflows/build-application.yml

@@ -5,6 +5,7 @@ on: [push]
 env:
   AWS_ACCESS_KEY_ID: ${{ secrets.kadena_cabal_cache_aws_access_key_id }}
   AWS_SECRET_ACCESS_KEY: ${{ secrets.kadena_cabal_cache_aws_secret_access_key }}
+  AWS_DEFAULT_REGION: us-east-1
 
 jobs:
   build:
@@ -102,9 +103,12 @@ jobs:
     # Publish artifacts to S3
     - name: Publish to S3
       run: |
+        aws --version
         tar -C ./artifacts/applications/ -czf $BINFILE test-miner
-        aws s3 cp $BINFILE s3://$ARTIFACT_BUCKET/$ARTIFACT_FOLDER/
-        aws s3api put-object-acl --bucket $ARTIFACT_BUCKET --key=$ARTIFACT_FOLDER/$BINFILE --acl public-read
+        echo "aws s3 cp $BINFILE s3://$ARTIFACT_BUCKET/$ARTIFACT_FOLDER/"
+        aws --debug s3 cp "$BINFILE" "s3://$ARTIFACT_BUCKET/$ARTIFACT_FOLDER/"
+        echo "aws s3api put-object-acl --bucket $ARTIFACT_BUCKET --key=$ARTIFACT_FOLDER/$BINFILE --acl public-read"
+        aws s3api put-object-acl --bucket "$ARTIFACT_BUCKET" --key="$ARTIFACT_FOLDER/$BINFILE" --acl public-read
     - name: Publish to S3 for master builds
       if: env.GIT_REF_SHORT == 'master'
       run: |

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for test-miner
+
+## 0.1 -- 2020-08-20
+
+* First version. Released on an unsuspecting world.

README.md

@@ -1,2 +1,10 @@
-A test miner for chainweb that simulates POW without actually solving the
-target.
+A mining client for Kadena Chainweb. It supports
+
+* multi threaded CPU mining,
+* external mining workers (e.g. a GPU),
+* simulated mining for testing.
+
+Competitive mining on the Kadena Chainweb Mainnet requires special mining
+hardware, which usually comes with its own mining client and mining pool
+support implementations. This generic mining client is intended mostly for
+testing.

test-miner.cabal

@@ -1,7 +1,7 @@
 cabal-version: 3.0
 name: test-miner
 version: 0.1
-synopsis: Test Miner
+synopsis: Mining Client for Kadena Chainweb
 homepage: https://github.com/kadena-io/test-miner
 bug-reports: https://github.com/kadena-io/test-miner/issues
 license: BSD-3-Clause
@@ -12,8 +12,8 @@ copyright: Copyright (c) 2019 - 2020, Kadena LLC
 category: Data, Mathematics
 build-type: Custom
 tested-with:
-      GHC==8.10.1
-    , GHC==8.8.3
+      GHC==8.10.2
+    , GHC==8.8.4
 extra-source-files:
     README.md
     CHANGELOG.md