Add note about workflow to trigger workflow

davidkun · Jul 4, 2024 · cd6793c · cd6793c
1 parent 79451b6
commit cd6793c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.github/workflows/hatch.yml b/.github/workflows/hatch.yml
@@ -3,6 +3,9 @@ on:
   push:
     paths:
       - 'hatch-demo/**'
+defaults:
+  run:
+    working-directory: ./hatch-demo
 
 jobs:
   test:
@@ -15,6 +18,8 @@ jobs:
           python-version: '3.12'
       - name: Install Hatch
         uses: pypa/hatch@install
+      - name: Create envs
+        run: hatch env create dev
       - name: Lint
         run: hatch run dev:check
       - name: Run tests

diff --git a/hatch-demo/README.md b/hatch-demo/README.md
@@ -99,6 +99,8 @@ run = "python src/hatch_demo/demo.py"
 $ hatch run default:run
 ```
 
+13. Add [hatch-based GH workflow](../.github/workflows/hatch.yml) to check linting and run tests
+
 ## Notes
 
 * Not sure how to install the project so that it can called like `python -m hatch_demo`