first commit

.github/ghadocs/examples/1_environment-variables.md

@@ -0,0 +1,13 @@
+<!-- markdownlint-disable first-line-heading -->
+
+### Example Using environment variables
+
+```yaml
+steps:
+  - uses: actions/checkout@v4.2.2
+  - uses: hoverkraft-tech/compose-action@v1.5.1
+    with:
+      compose-file: "./docker/docker-compose.yml"
+    env:
+      CUSTOM_VARIABLE: "test"
+```

.github/ghadocs/examples/2_services.md

@@ -0,0 +1,17 @@
+<!-- markdownlint-disable first-line-heading -->
+
+### Example using `services`
+
+Perform `docker compose up` to some given service instead of all of them
+
+```yaml
+steps:
+  # need checkout before using compose-action
+  - uses: actions/checkout@v3
+  - uses: hoverkraft-tech/compose-action@v1.5.1
+    with:
+      compose-file: "./docker/docker-compose.yml"
+      services: |
+        helloworld2
+        helloworld3
+```

.github/ghadocs/examples/3_up-flags.md

@@ -0,0 +1,8 @@
+<!-- markdownlint-disable first-line-heading -->
+
+### Example using `up-flags`
+
+Specify flags to pass to the `docker compose up`. Default is none. Can be used
+to pass the `--build` flag, for example, if you want persistent volumes to be
+deleted as well during cleanup. A full list of flags can be found in the
+[docker compose up documentation](https://docs.docker.com/compose/reference/up/).

.github/ghadocs/examples/4_down-flags.md

@@ -0,0 +1,9 @@
+<!-- markdownlint-disable first-line-heading -->
+
+### Example using `down-flags`
+
+Specify flags to pass to the `docker-compose down` command during cleanup.
+Default is none. Can be used to pass the `--volumes` flag, for example, if you
+want persistent volumes to be deleted as well during cleanup. A full list of
+flags can be found in the
+[docker-compose down documentation](https://docs.docker.com/compose/reference/down/).

.github/ghadocs/examples/5_compose-flags.md

@@ -0,0 +1,19 @@
+<!-- markdownlint-disable first-line-heading -->
+
+### Example using `compose-flags`
+
+Specify flags to pass to the `docker compose` command. Default is none. A full
+list of flags can be found in the
+[docker compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help).
+
+```yaml
+steps:
+  # need checkout before using compose-action
+  - uses: actions/checkout@v3
+  - uses: hoverkraft-tech/compose-action@v1.5.1
+    with:
+      compose-file: "./docker/docker-compose.yml"
+      services: |
+        helloworld2
+        helloworld3
+```

.github/ghadocs/examples/6_multiple-compose-files.md

@@ -0,0 +1,18 @@
+<!-- markdownlint-disable first-line-heading -->
+
+### Example with multiple compose files
+
+Specify multiple compose files to use with the `docker compose` command. This is
+useful when you have a base compose file and additional files for different
+environments or configurations.
+
+```yaml
+steps:
+  # need checkout before using compose-action
+  - uses: actions/checkout@v3
+  - uses: hoverkraft-tech/compose-action@v1.5.1
+    with:
+      compose-file: |
+        ./docker/docker-compose.yml
+        ./docker/docker-compose.ci.yml
+```