Merge pull request #379 from lightningrodlabs/feat/release-webhapp-ci

Add github workflow to release webhapps via CI

Author: matthme

.github/workflows/release-webhapps.yaml

@@ -0,0 +1,54 @@
+name: 'release-webhapps'
+on:
+  push:
+    branches:
+      - release-webhapps
+
+jobs:
+  publish-happ:
+    permissions:
+      contents: write
+    runs-on: ubuntu-22.04
+    outputs:
+      releaseId: ${{ steps.create-release.outputs.id }}
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      # Checks out a copy of your repository on the ubuntu-latest machine
+      - uses: actions/checkout@v3
+
+      - name: Extend space
+        uses: ./.github/actions/extend-space
+
+      - name: Install nix
+        uses: cachix/install-nix-action@v20
+        with:
+          install_url: https://releases.nixos.org/nix/nix-2.23.0/install
+
+      - uses: cachix/cachix-action@v15
+        with:
+          name: holochain-ci
+
+      - name: Install and build
+        run: |
+          nix-store --gc
+          nix develop --command bash -c "holochain --version && yarn && yarn pack-happs && yarn build-webhapp"
+          shasum -a 256 ./happs/happ/workdir/acorn.happ
+          shasum -a 256 ./happs/happ/workdir/acorn.webhapp
+
+      - name: Retrieve version
+        run: |
+          echo "APP_VERSION=$(cat package.json | grep -oP '(?<="version": ")[^"]*')" >> $GITHUB_OUTPUT
+        id: version
+
+      - id: create-release
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: false
+          artifacts:
+            - 'happs/happ/workdir/acorn.webhapp'
+            - 'happs/happ/workdir/acorn.happ'
+          body: 'See assets below to download and install this version.'
+          name: v${{ steps.version.outputs.APP_VERSION }}-alpha
+          tag: v${{ steps.version.outputs.APP_VERSION }}-alpha
+          prerelease: true
+          draft: true

DEVELOPERS.md

@@ -24,7 +24,7 @@ This will launch the ui and a electron app with the holochain conductor preconfi
 
 If you want multiple instances to test multi-agent scenarios run `yarn run desktop:happ -n 2` (or any number)
 
-Alternatively, instead of launching the ui separately, you can run `yarn run desktop:build-webhapp` and then `yarn run desktop:webhapp`. This will launch a fully packaged webhapp in a preconfigured electron environment.
+Alternatively, instead of launching the ui separately, you can run `yarn run build-webhapp` and then `yarn run desktop:webhapp`. This will launch a fully packaged webhapp in a preconfigured electron environment.
 
 ### Acorn Moss Tool
 
@@ -33,27 +33,29 @@ Alternatively, instead of launching the ui separately, you can run `yarn run des
 
 If you want 2 agents, open a 3rd terminal window and run `yarn run moss:happ2`
 
-If you want to test the full webhapp, run `yarn run moss:build-webhapp` then run `yarn run moss:webhapp`. If you want a second agent, run `yarn run moss:webhapp2`.
+If you want to test the full webhapp, run `yarn run build-webhapp` then run `yarn run moss:webhapp`. If you want a second agent, run `yarn run moss:webhapp2`.
 
 ### Building / Packaging Desktop App
 
-First, build the webhapp if you haven't done so yet:
+#### Step 1: Release webhapp on github
 
-- `yarn run desktop:build-webhapp`
+First, the webapp needs to be released on github from where it can later be pulled by the CI of the `[acorn-desktop](https://github.com/lightningrodlabs/acorn-desktop)` repository.
 
-This will create an `[acorn-desktop.webhapp](./happs/happ/workdir/acorn-desktop.webhapp)` file. Upload this to the [Acorn release page](https://github.com/lightningrodlabs/acorn/releases) with the appropriate version tag.
+To release the webhapp, update the version number of acorn in the project, including in the root level `package.json` (see [Versioning](#versioning) below), to the version that you want to release Acorn under. Then checkout the `release` branch, merge `main` into the `release` branch and push. This should trigger CI to build and release the webhapp file on github as a draft release. You can then double-check the draft release and if everything looks fine, publish it.
 
-Then, clone the `[acorn-desktop](https://github.com/lightningrodlabs/acorn-desktop/tree/v11.1.2)` repo. Trigger a release by following the instructions in the README. This should trigger a github action which automatically fetches the webhapp from the previous step and builds and releases multi-platform versions of Acorn, signed and ready to download on the [release page](https://github.com/lightningrodlabs/acorn-desktop/releases).
+#### Step 2: Build the Desktop App
+
+Then, clone the `[acorn-desktop](https://github.com/lightningrodlabs/acorn-desktop)` repo. Update the link to the webhapp in the `kangaroo.config.ts` file and trigger a release by following the instructions in the README. This should trigger a github action which automatically fetches the webhapp from the previous step and builds and releases multi-platform versions of Acorn, signed and ready to download on the [release page](https://github.com/lightningrodlabs/acorn-desktop/releases).
 
 ### Building / Packaging Moss Tool
 
-Build the webhapp,
+To build the Moss tool, all you need to do is building the webhapp. You can either build it locally or through CI as described [above](#step-1-release-webhapp-on-github). TO build it locally, run:
 
-- `yarn run moss:build-webhapp`
+- `yarn run build-webhapp`
 
-This will create an `[acorn-moss.webhapp](./weave-tool/acorn-moss.webhapp)` file. Upload this to the [Acorn release page](https://github.com/lightningrodlabs/acorn/releases) with the appropriate version tag.
+This will create an `acorn.webhapp` file in the `./happs/happ/workdir` directory.
 
-Publish this to the weave tool curation list, following the instruction [here](https://github.com/lightningrodlabs/weave-tool-curation/blob/main/0.13/README.md). You can view an example PR of this [here](https://github.com/lightningrodlabs/weave-tool-curation/pull/40).
+Then publish this to the weave tool curation list, following the instruction [here](https://github.com/lightningrodlabs/weave-tool-curation/blob/main/0.14/README.md). You can view an example PR of this [here](https://github.com/lightningrodlabs/weave-tool-curation/pull/40).
 
 ### Versioning
 

happs/CODE_OF_CONDUCT.md

@@ -1,11 +1,3 @@
 # Acorn hApp
 
-This repository is home to the holochain hApp definitions, DNA definitions and Zome Rust/WASM code.
-
-This repository is used just for developing and releasing the two hApp files that Acorn consists of: Profiles, and Projects.
-
-The main repository for the end-user application is [Acorn](https://github.com/lightningrodlabs/acorn).
-
-- Are you a developer? [Read on](./DEVELOPERS.md).
-
-© 2020-2023 Harris-Braun Enterprises, LLC, operating as [Lightningrod Labs](https://lightningrodlabs.org). Licensed under the [Cryptographic Autonomy License v1.0](https://opensource.org/licenses/CAL-1.0).
+This folder is home to the holochain hApp definitions, DNA definitions and Zome Rust/WASM code.

happs/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 ---
 manifest_version: '1'
-name: acorn-desktop
+name: acorn
 ui:
   bundled: '../../../web/dist.zip'
 happ_manifest: