Merge pull request #172 from hirosystems/main

chore: update develop branch

Author: lgalabru

.github/workflows/ci.yaml

@@ -344,22 +344,30 @@ jobs:
             ./target/${{ matrix.target }}/release/clarinet test --manifest-path ${testdir}/Clarinet.toml
           }
 
-      - name: Upload Artifacts to GH release (Not Windows)
+      - name: Upload Cargo Artifact to GH release (Not Windows)
         uses: svenstaro/upload-release-action@v2
         if: startsWith(github.ref, 'refs/tags/v') && matrix.os != 'windows-latest'
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: clarinet-${{ matrix.platform }}-${{ matrix.architecture }}.tar.gz
           tag: ${{ github.ref }}
 
-      - name: Upload Artifacts to GH release (Windows)
+      - name: Upload Cargo Artifact to GH release (Windows)
         uses: svenstaro/upload-release-action@v2
         if: startsWith(github.ref, 'refs/tags/v') && matrix.os == 'windows-latest'
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: clarinet-${{ matrix.platform }}-${{ matrix.architecture }}.msi
           tag: ${{ github.ref }}
 
+      - name: Upload Node Artifact to GH release
+        uses: svenstaro/upload-release-action@v2
+        if: startsWith(github.ref, 'refs/tags/v')
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: stacks-devnet-js-${{ matrix.platform }}-${{ matrix.architecture }}.tar.gz
+          tag: ${{ github.ref }}
+
       # Cleans the `./target` dir after the build such that only dependencies are cached on CI
       - name: Prepare cache
         run: cargo xtask pre-cache

.github/workflows/pkg-version-bump.yaml

@@ -33,7 +33,7 @@ jobs:
           brew bump-formula-pr \
             --no-browse \
             --no-audit \
-            --tag "${TAG}"
+            --tag "${TAG}" \
             ${{ github.event.repository.name }}
 
   winget:

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.20.0](https://github.com/hirosystems/clarinet/compare/v0.19.1...v0.20.0) (2021-12-09)
+
+
+### Features
+
+* document CI how-to ([a4079d9](https://github.com/hirosystems/clarinet/commit/a4079d96dd762ae85804bd1d8b116eac75447dac))
+
 ## [0.19.1](https://github.com/hirosystems/clarinet/compare/v0.19.0...v0.19.1) (2021-12-06)
 
 

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "clarinet"
-version = "0.19.1"
+version = "0.20.0"
 authors = ["Ludo Galabru <ludo@hiro.so>"]
 edition = "2018"
 description = "Clarinet is a clarity runtime packaged as a command line tool, designed to facilitate smart contract understanding, development, testing and deployment."

Cargo.toml

@@ -64,7 +64,7 @@ sudo apt install build-essential pkg-config libssl-dev
 You can build Clarinet from source using Cargo with the following commands:
 
 ```bash
-git clone git@github.com:hirosystems/clarinet.git --recursive
+git clone https://github.com/hirosystems/clarinet.git --recursive
 cd clarinet
 cargo install --path . --locked
 ```
@@ -235,6 +235,34 @@ evaluation on a blockchain. Use the following command:
 $ clarinet deploy --testnet
 ```
 
+### Use Clarinet in your CI workflow as a GitHub Action
+
+Clarinet can be used in GitHub Actions as a step of your CI workflows. 
+You can set-up a simple workflow by adding the following steps in a file `.github/workflows/github-actions-clarinet.yml`:
+
+```yaml
+name: CI
+on: [push]
+jobs:
+  tests:
+    name: "Test contracts with Clarinet"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: "Execute unit tests"
+        uses: docker://hirosystems/clarinet:latest
+        with: 
+          args: test --coverage --manifest-path=./Clarinet.toml
+      - name: "Export code coverage"
+        uses: codecov/codecov-action@v1
+        with:
+          files: ./coverage.lcov
+          verbose: true
+```
+
+Or add the steps above in your existing workflows.
+The generated code coverage output can then be used as is with GitHub Apps like https://codecov.io.
+
 ### Extensions
 
 Clarinet can easily be extended by community members: open source contributions to clarinet are welcome, but developers can also write their own clarinet extensions if they want to integrate clarity contracts with their own tooling and workflow.

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "stacks-devnet-js"
-version = "0.19.1"
+version = "0.20.0"
 license = "ISC"
 edition = "2018"
 exclude = ["index.node"]

node-bindings/Cargo.lock

@@ -1,6 +1,6 @@
 {
   "name": "@hirosystems/stacks-devnet-js",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "stacks-devnet-js is a library for writing end to end tests for protocols interacting with the Stacks blockchain and the Bitcoin blockchain.",
   "author": "Ludo Galabru",
   "license": "GPL-3.0",