Add examples

.vscode/settings.json

@@ -1,5 +1,9 @@
 {
   "yaml.schemas": {
-    "./schema/runny.schema.json": ["fixtures/*.yaml", ".runny.yaml"]
+    "./schema/runny.schema.json": [
+      ".runny.yaml",
+      "examples/*.yaml",
+      "fixtures/*.yaml"
+    ]
   }
 }

README.md

@@ -48,3 +48,7 @@ Then run commands with runny:
 ```command
 runny pip-install ruff
 ```
+
+## Examples
+
+Have a look in the [examples folder](./examples/) for examples of how you might use Runny with various languages and frameworks.

examples/README.md

@@ -0,0 +1,3 @@
+# Runny Examples
+
+These files are named after a language or technology, but bear in mind that your Runny config should always be called `.runny.yaml`.

examples/docker-compose.runny.yaml

@@ -0,0 +1,17 @@
+commands:
+  # Top tip: Docker Compose has good command-line completion already. But using runny, you can add entries for just the
+  # commands you use regularly, then get an uncluttered list of options when you tab-complete.
+  up:
+    run: docker compose up -d
+  down:
+    run: docker compose down
+  build-and-up:
+    run: docker compose up --build -d
+  logs:
+    argnames:
+      - service
+    run: docker compose logs $service
+  shell:
+    argnames:
+      - service
+    run: docker compose exec $service sh

examples/go.runny.yaml

@@ -0,0 +1,23 @@
+commands:
+  clean:
+    run: |
+      go clean ./...
+      rm -rf dist
+  install-goreleaser:
+    if: "! command -v goreleaser"
+    run: brew install goreleaser/tap/goreleaser
+  release:
+    needs:
+      - clean
+      - install-goreleaser
+    run: |
+      export GITHUB_TOKEN=$(gh auth token)
+      goreleaser
+  generate-schema:
+    run: go generate ./...
+  test:
+    run: go test ./...
+  test-coverage:
+    run: go test -coverprofile=c.out ./... && go tool cover -func="c.out"
+  test-coverage-html:
+    run: go test -coverprofile=c.out ./... && go tool cover -html="c.out"

examples/python-uv.runny.yaml

@@ -0,0 +1,20 @@
+commands:
+  install-uv:
+    if: "! command -v uv"
+    run: pip install uv
+  pip-sync:
+    needs:
+      - install-uv
+    run: uv pip sync requirements.txt
+  pip-compile-and-sync:
+    needs:
+      - install-uv
+    run: |
+      uv pip compile requirements.in -o requirements.txt
+      uv pip sync requirements.txt
+  pip-install:
+    argnames:
+      - packagespec
+    run: echo $packagespec >> requirements.in
+    then:
+      - pip-compile-and-sync

examples/python.runny.yaml

@@ -0,0 +1,9 @@
+commands:
+  update-requirements:
+    run: pip freeze > requirements.txt
+  pip-install:
+    argnames:
+      - packagespec
+    run: pip install $packagespec
+    then:
+      - update-requirements