docs: README

Author: AriPerkkio

README.md

@@ -0,0 +1,56 @@
+# vitest-ecosystem-ci
+
+This repository is used to run tests for vitest ecosystem projects
+
+## via github workflow
+
+### scheduled
+
+Workflows are sheduled to run automatically every Monday, Wednesday and Friday
+
+### manually
+
+- open [workflow](../../actions/workflows/ecosystem-ci-selected.yml)
+- click 'Run workflow' button on top right of the list
+- select suite to run in dropdown
+- start workflow
+
+## via shell script
+
+- clone this repo
+- run `pnpm i`
+- run `pnpm test` to run all suites
+- or `pnpm test <suitename>` to select a suite
+- or `tsx ecosystem-ci.ts`
+
+You can pass `--tag v2.8.0-beta.1`, `--branch somebranch` or `--commit abcd1234` option to select a specific vitest version to build.
+If you pass `--release 2.7.13`, vitest build will be skipped and vitest is fetched from the registry instead
+
+The repositories are checked out into `workspace` subdirectory as shallow clones
+
+# how to add a new integration test
+
+- check out the existing [tests](./tests) and add one yourself. Thanks to some utilities it is really easy
+- once you are confidente the suite works, add it to the lists of suites in the [workflows](../../actions/)
+
+> the current utilities focus on pnpm based projects. Consider switching to pnpm or contribute utilities for other pms
+
+# reporting results
+
+## Discord
+
+Results are posted automatically to `#ecosystem-ci` on [vitest discord](https://chat.vitest.dev/)
+
+### on your own server
+
+- Go to `Server settings > Integrations > Webhooks` and click `New Webhook`
+- Give it a name, icon and a channel to post to
+- copy the webhook url
+- get in touch with admins of this repo so they can add the webhook
+
+#### how to add a discord webhook here
+
+- Go to `<github repo>/settings/secrets/actions` and click on `New repository secret`
+- set `Name` as `DISCORD_WEBHOOK_URL`
+- paste the discord webhook url you copied from above into `Value`
+- Click `Add secret`