diff --git a/.github/workflows/main-ci.yml b/.github/workflows/main-ci.yml index 825f201..1e3145a 100644 --- a/.github/workflows/main-ci.yml +++ b/.github/workflows/main-ci.yml @@ -36,7 +36,7 @@ jobs: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 - name: 📖 Generate documentation - uses: hoverkraft-tech/ci-dokumentor@4ad2ab669afb9516c4b9d026f093d23350132589 # 0.1.1 + uses: hoverkraft-tech/ci-dokumentor@fe7b78e19572b70e2a5db7f2a61b99c70358061a # 0.1.2 with: source: action.yml diff --git a/action.yml b/action.yml index 257cf2f..ffd8ace 100644 --- a/action.yml +++ b/action.yml @@ -1,23 +1,20 @@ +# ### Action +# +# The action will run `docker compose up` to start the services defined in the given compose file(s). +# The compose file(s) can be specified using the `compose-file` input. +# Some extra options can be passed to the `docker compose up` command using the `up-flags` input. +# +# ### Post hook +# +# On post hook, the action will run `docker compose down` to clean up the services. +# +# Logs of the Docker Compose services are logged using GitHub `core.ts` API before the cleanup. +# The log level can be set using the `services-log-level` input. +# The default is `debug`, which will only print logs if [debug mode](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging) is switched on. +# +# Some extra options can be passed to the `docker compose down` command using the `down-flags` input. name: "Docker Compose Action" -description: | - This action runs your compose file(s) and clean up before action finished - - ### Action - - The action will run `docker compose up` to start the services defined in the given compose file(s). - The compose file(s) can be specified using the `compose-file` input. - Some extra options can be passed to the `docker compose up` command using the `up-flags` input. - - ### Post hook - - On post hook, the action will run `docker compose down` to clean up the services. - - Logs of the Docker Compose services are logged using GitHub `core.ts` API before the cleanup. - The log level can be set using the `services-log-level` input. - The default is `debug`, which will only print logs if [debug mode](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/enabling-debug-logging) is switched on. - - Some extra options can be passed to the `docker compose down` command using the `down-flags` input. - +description: This action runs your compose file(s) and clean up before action finished author: "hoverkraft" branding: icon: anchor