updates

.github/workflows/preview.yaml

@@ -17,8 +17,14 @@ jobs:
         with:
           repository: TBD54566975/web5-spec
           path: web5-spec
-      - name: Copy test-vectors
-        run: cp -r web5-spec/test-vectors .
+        uses: actions/checkout@v3
+        with:
+          repository: TBD54566975/tbdex
+          path: tbdex
+      - name: Copy web5-spec test-vectors
+        run: cp -r web5-spec/test-vectors ./test-vectors
+      - name: Copy tbdex test-vectors
+        run: cp -r tbdex/hosted/test-vectors ./tbdex-test-vectors
       - name: build html
         run: |
           cd reports
@@ -34,7 +40,7 @@ jobs:
         if: github.event.action != 'closed'
       - uses: rossjrw/pr-preview-action@v1
         with:
-          source-dir: .
+          source-dir: ./_site
           preview-branch: gh-pages
           umbrella-dir: pr-preview
           action: auto

.gitignore

@@ -0,0 +1,2 @@
+.idea
+_site

CODE_OF_CONDUCT.md

@@ -5,7 +5,6 @@ TBD builds infrastructure for the next wave of innovation in financial services
 
 The code of conduct below reflects the expectations for ourselves and for our community.
 
-
 ## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our
@@ -90,7 +89,7 @@ actions.
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media and forums. 
+like social media and forums.
 
 Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.
 

CONTRIBUTING.md

@@ -1,10 +1,11 @@
-# Contribution Guide 
+# Contribution Guide
+<!-- markdownlint-disable -->
 
 There are many ways to be an open source contributor, and we're here to help you on your way! You may:
 
-* Propose ideas in our 
+* Propose ideas in our
   [discord](https://discord.gg/tbd)
-* Raise an issue or feature request in our [issue tracker](LINK_HERE)  ___***FIX LINK AND REMOVE THIS NOTICE***___
+* Raise an issue or feature request in our [issue tracker](https://github.com/TBD54566975/sdk-report-runner/issues)
 * Help another contributor with one of their questions, or a code review
 * Suggest improvements to our Getting Started documentation by supplying a Pull Request
 * Evangelize our work together in conferences, podcasts, and social media spaces.
@@ -13,7 +14,7 @@ This guide is for you.
 
 ## Development Prerequisites
 
-___***UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES***___
+___*__UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES__*___
 
 | Requirement | Tested Version | Installation Instructions                            |
 |-------------|----------------|------------------------------------------------------|
@@ -23,7 +24,7 @@ ___***UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES***___
 
 ### Go
 
-This project is written in Go, a modern, open source programming language. 
+This project is written in Go, a modern, open source programming language.
 
 You may verify your `go` installation via the terminal:
 
@@ -37,6 +38,7 @@ If you do not have go, we recommend installing it by:
 #### MacOS
 
 ##### Homebrew
+
 ```
 $> brew install go
 ```
@@ -73,13 +75,13 @@ Installation instructions are on the [Magefile home page](https://magefile.org/)
 
 ### Java
 
-This project is written in Java, a typesafe, compiled programming language. 
+This project is written in Java, a typesafe, compiled programming language.
 
 You may verify your `java` installation via the terminal by running `java -version`.
 
-If you do not have Java, we recommend installing it 
-via [SDKMan](https://sdkman.io/install). This is a project which will allow you 
-to easily install the Java Development Kit (JDK), runtime (JRE), and related frameworks, 
+If you do not have Java, we recommend installing it
+via [SDKMan](https://sdkman.io/install). This is a project which will allow you
+to easily install the Java Development Kit (JDK), runtime (JRE), and related frameworks,
 build tools, and runtimes.
 
 After you've installed SDKMan, you may install Java:
@@ -122,11 +124,13 @@ $> mage build
 ## Build (Java / Gradle)
 
 ### macOS / Linux
+
 ```shell
 $> ./gradlew build
 ```
 
 ### Windows
+
 ```shell
 $> gradlew.bat build
 ```
@@ -140,11 +144,13 @@ $> mage test
 ## Test (Java / Gradle)
 
 ### macOS / Linux
+
 ```shell
 $> ./gradlew test
 ```
 
 ### Windows
+
 ```shell
 $> gradlew.bat test
 ```
@@ -164,8 +170,8 @@ $> ./gradlew clean build test
 
 ### Issues
 
-Anyone from the community is welcome (and encouraged!) to raise issues via 
-[GitHub Issues](LINK_HERE)  ___***FIX LINK AND REMOVE THIS NOTICE***___.
+Anyone from the community is welcome (and encouraged!) to raise issues via
+[GitHub Issues](https://github.com/TBD54566975/sdk-report-runner/issues).
 
 ### Discussions
 
@@ -175,40 +181,38 @@ We advocate an asynchronous, written debate model - so write up your thoughts an
 
 ### Continuous Integration
 
-Build and Test cycles are run on every commit to every branch on [CircleCI](LINK_HERE).
-
- ___***FIX LINK ABOVE AND REMOVE THIS NOTICE***___
+Build and Test cycles are run on every commit to every branch on [GitHub Actions](https://github.com/TBD54566975/sdk-report-runner/actions).
 
 ## Contribution
 
-We review contributions to the codebase via GitHub's Pull Request mechanism. We have 
-the following guidelines to ease your experience and help our leads respond quickly 
+We review contributions to the codebase via GitHub's Pull Request mechanism. We have
+the following guidelines to ease your experience and help our leads respond quickly
 to your valuable work:
 
-* Start by proposing a change either in Issues (most appropriate for small 
-  change requests or bug fixes) or in Discussions (most appropriate for design 
-  and architecture considerations, proposing a new feature, or where you'd 
+* Start by proposing a change either in Issues (most appropriate for small
+  change requests or bug fixes) or in Discussions (most appropriate for design
+  and architecture considerations, proposing a new feature, or where you'd
   like insight and feedback)
-* Cultivate consensus around your ideas; the project leads will help you 
-  pre-flight how beneficial the proposal might be to the project. Developing early 
-  buy-in will help others understand what you're looking to do, and give you a 
-  greater chance of your contributions making it into the codebase! No one wants to 
+* Cultivate consensus around your ideas; the project leads will help you
+  pre-flight how beneficial the proposal might be to the project. Developing early
+  buy-in will help others understand what you're looking to do, and give you a
+  greater chance of your contributions making it into the codebase! No one wants to
   see work done in an area that's unlikely to be incorporated into the codebase.
 * Fork the repo into your own namespace/remote
-* Work in a dedicated feature branch. Atlassian wrote a great 
+* Work in a dedicated feature branch. Atlassian wrote a great
   [description of this workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow)
 * When you're ready to offer your work to the project, first:
-* Squash your commits into a single one (or an appropriate small number of commits), and 
-  rebase atop the upstream `main` branch. This will limit the potential for merge 
-  conflicts during review, and helps keep the audit trail clean. A good writeup for 
-  how this is done is 
-  [here](https://medium.com/@slamflipstrom/a-beginners-guide-to-squashing-commits-with-git-rebase-8185cf6e62ec), and if you're 
-  having trouble - feel free to ask a member or the community for help or leave the commits as-is, and flag that you'd like 
+* Squash your commits into a single one (or an appropriate small number of commits), and
+  rebase atop the upstream `main` branch. This will limit the potential for merge
+  conflicts during review, and helps keep the audit trail clean. A good writeup for
+  how this is done is
+  [here](https://medium.com/@slamflipstrom/a-beginners-guide-to-squashing-commits-with-git-rebase-8185cf6e62ec), and if you're
+  having trouble - feel free to ask a member or the community for help or leave the commits as-is, and flag that you'd like
   rebasing assistance in your PR! We're here to support you.
 * Open a PR in the project to bring in the code from your feature branch.
-* The maintainers noted in the `CODEOWNERS` file will review your PR and optionally 
+* The maintainers noted in the `CODEOWNERS` file will review your PR and optionally
   open a discussion about its contents before moving forward.
 * Remain responsive to follow-up questions, be open to making requested changes, and...
   You're a contributor!
-* And remember to respect everyone in our global development community. Guidelines 
+* And remember to respect everyone in our global development community. Guidelines
   are established in our `CODE_OF_CONDUCT.md`.

reports/README.md

@@ -2,8 +2,7 @@
 
 This tool reads junit XML reports from different SDKs and generates an HTML report showing which SDKs support which features.
 
-`./cmd/build-html` will iterate over the repos listed in `sdk.go` and download the most recent junit artifact. It will read
-all junit results from it and produce a report to `_site/index.html`.  For local testing, generate a
+`./cmd/build-html` will iterate over the repos listed in `sdk.go` and download the most recent junit artifact. It will read all junit results from it and produce a report to `_site/index.html`.  For local testing, generate a
 [GitHub Personal Access Token](https://github.com/settings/tokens?type=beta) and put it in an environment variable named
 `GITHUB_TOKEN`. It doesn't need any special permissions ("Public Repositories (read-only)"). Note that a GitHub app (explained below) can also be used.
 
@@ -14,3 +13,15 @@ For local testing, a [GitHub App](https://github.com/settings/apps) must be crea
 * `CICD_ROBOT_GITHUB_APP_PRIVATE_KEY` - this should be the contents of the private key, not the path to the file.
 * `CICD_ROBOT_GITHUB_APP_NAME` - this is used as a display name and should match the name in the URL of the edit page for the app.
 * `CICD_ROBOT_GITHUB_APP_INSTALLATION_ID` - click "Install App" on the sidebar while editing the app in GitHub to install it on your own account.
+
+## Tooling
+
+This project uses [hermit](https://cashapp.github.io/hermit/usage/get-started/), an open source toolchain manager, which pins and automatically downloads and installs tooling for a repo, including compiler toolchains, utilities, etc.
+
+To install hermit, run:
+
+```bash
+https://github.com/cashapp/hermit/releases/download/stable/install.sh | /bin/bash
+```
+
+If using goland or intellij, also install the hermit plugin via [these instructions](https://cashapp.github.io/hermit/usage/ide/).