Skip to content

Commit

Permalink
Merge pull request #1 from lightningrodlabs/empty-start
Browse files Browse the repository at this point in the history
Empty start
  • Loading branch information
matthme authored Dec 19, 2024
2 parents eae014c + e4053ec commit 2c6b6e2
Show file tree
Hide file tree
Showing 17 changed files with 1,115 additions and 80 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Deploy Lists to Github Pages

on:
# Runs on pushes targeting the `main` branch.
push:
branches: main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: yarn # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Move lists to static directory
run: |
mkdir static
mkdir static/0.13
cp ./0.13/lists/curations-0.13.json ./static/0.13
cp ./0.13/lists/tool-list-0.13.json ./static/0.13
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: static

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules
node_modules
static
45 changes: 38 additions & 7 deletions 0.13/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,47 @@
# Curation List for Moss 0.13

This folder contains a curations list and a Tools list.

**Curation List**:
A curation list is a list of curations of Weave Tools maintained by a curator. It can contain
multiple curations listing Tools of different developer collectives.

**Tools List**:
A Tools list is a list of Weave Tools maintained by a developer collective. It contains information
about the developer collective as well as a list of Tools and available versions thereof. A Tool
is identified by an `id` and a `versionBranch`, where all versions of a Tool belonging to the same
`versionBranch` are assumed to be compatible.

## Computing Sha256 Hashes of .webhapp files

To verify the integrity of the files, the sha256 hashes of the `.webhapp`, `.happ` and the UI are
required for every Tool version in a Tools list. These get stored in the group DNA of a Moss
group so that each group member can verify that they download the same Tool as other group
members.

To compute these hashes you can use the Weave CLI [`@theweave/cli`](https://www.npmjs.com/package/@theweave/cli) and
run the following command:
```
weave hash-webhapp [path or URL to your Tool's webhapp file]
```

> [!IMPORTANT]
> It is important to use the Weave CLI for computing the hashes as the hashes may differ from computing them manually
and they need to match with how Moss computes them.

## Modifying the Curation List

0. Run `npm install`
1. Go to `./modify/curation.ts` and change the file as needed
2. Run `npm run write-lists` which should update `./lists/curation.json`.
3. Make a PR with the new change
1. Go to `./modify/curations-0.13.ts` and change the file as needed
2. Run `npm run write-lists` which should update `./lists/curations-0.13.json`.
3. run `npm run test` to run basic validity checks for the generated json file.
4. Make a PR with the new change

## Modifying the Developer Collective List
## Modifying the Tools List

0. Run `npm install`
1. Go to `./modify/developerCollective.ts` and change the file as needed
2. Run `npm run write-lists` which should update `./lists/curation.json`.
3. Make a PR with the new change
1. Go to `./modify/tool-list-0.13.ts` and change the file as needed
2. Run `npm run write-lists` which should update `./lists/tool-list-0.13.json`.
3. run `npm run test` to run basic validity checks for the generated json file.
4. Make a PR with the new change

9 changes: 0 additions & 9 deletions 0.13/lists/curation.json

This file was deleted.

18 changes: 18 additions & 0 deletions 0.13/lists/curations-0.13.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"curator": {
"name": "Lightningrod Labs",
"description": "The official curation of Tools from Lightningrod Labs",
"contact": {
"website": "https://lightningrodlabs.org"
},
"icon": "https://lightningrodlabs.org/lrl_logo.png"
},
"curationLists": {
"default": {
"name": "Default Curation List",
"description": "Default Curation List of Lightningrod Labs",
"tags": [],
"tools": []
}
}
}
10 changes: 0 additions & 10 deletions 0.13/lists/developerCollective.json

This file was deleted.

12 changes: 12 additions & 0 deletions 0.13/lists/tool-list-0.13.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"developerCollective": {
"id": "lightningrodlabs",
"name": "Lightningrod Labs",
"description": "Nurturing The Holochain Ecosystem",
"icon": "https://lightningrodlabs.org/lrl_logo.png",
"contact": {
"website": "https://lightningrodlabs.org"
}
},
"tools": []
}
11 changes: 0 additions & 11 deletions 0.13/modify/curation.ts

This file was deleted.

20 changes: 20 additions & 0 deletions 0.13/modify/curations-0.13.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { defineCurationLists } from "@theweave/moss-types";

export default defineCurationLists({
curator: {
name: "Lightningrod Labs",
description: "The official curation of Tools from Lightningrod Labs",
contact: {
website: "https://lightningrodlabs.org",
},
icon: "https://lightningrodlabs.org/lrl_logo.png",
},
curationLists: {
default: {
name: "Default Curation List",
description: "Default Curation List of Lightningrod Labs",
tags: [],
tools: [],
},
},
});
13 changes: 0 additions & 13 deletions 0.13/modify/developerCollective.ts

This file was deleted.

14 changes: 14 additions & 0 deletions 0.13/modify/tool-list-0.13.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { defineDevCollectiveToolList } from "@theweave/moss-types";

export default defineDevCollectiveToolList({
developerCollective: {
id: "lightningrodlabs",
name: "Lightningrod Labs",
description: "Nurturing The Holochain Ecosystem",
icon: "https://lightningrodlabs.org/lrl_logo.png",
contact: {
website: "https://lightningrodlabs.org",
},
},
tools: [],
});
Loading

0 comments on commit 2c6b6e2

Please sign in to comment.