chore: wip

stacksjs · Mar 5, 2024 · 2cfb363 · 2cfb363
1 parent bbb6783
commit 2cfb363
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -0,0 +1,13 @@
+# GitHub Actions
+
+This folder contains the following GitHub Actions:
+
+- [CI][CI] - all CI jobs for the project
+  - lints the code
+  - `typecheck`s the code
+  - runs test suite
+  - runs on `ubuntu-latest`
+- [Release][Release] - automates the release process & changelog generation
+
+[CI]: ./workflows/ci.yml
+[Release]: ./workflows/release.yml