From b49a5ca3bbfbd743fb353a81d2b931b2005202c6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 10:24:06 +0000 Subject: [PATCH] chore(deps): bump the github-actions-dependencies group across 1 directory with 3 updates Bumps the github-actions-dependencies group with 3 updates in the / directory: [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common), [hoverkraft-tech/ci-dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor) and [actions/create-github-app-token](https://github.com/actions/create-github-app-token). --- updated-dependencies: - dependency-name: hoverkraft-tech/ci-github-common dependency-version: 0.25.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions-dependencies - dependency-name: hoverkraft-tech/ci-dokumentor dependency-version: 0.1.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions-dependencies - dependency-name: actions/create-github-app-token dependency-version: 2.1.4 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github-actions-dependencies ... Signed-off-by: dependabot[bot] Signed-off-by: Emilien Escalle --- .github/workflows/__shared-ci.yml | 2 +- .github/workflows/greetings.yml | 2 +- .github/workflows/main-ci.yml | 6 +++--- .github/workflows/need-fix-to-issue.yml | 2 +- .github/workflows/semantic-pull-request.yml | 2 +- .github/workflows/stale.yml | 2 +- README.md | 14 +++++++++++++- action.yml | 2 +- 8 files changed, 22 insertions(+), 10 deletions(-) diff --git a/.github/workflows/__shared-ci.yml b/.github/workflows/__shared-ci.yml index 2390fa4..4f9b22e 100644 --- a/.github/workflows/__shared-ci.yml +++ b/.github/workflows/__shared-ci.yml @@ -13,7 +13,7 @@ permissions: jobs: linter: - uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0 + uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0 with: linter-env: | FILTER_REGEX_EXCLUDE=dist/**/* diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index 831efe7..d41646d 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -13,4 +13,4 @@ permissions: jobs: greetings: - uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0 + uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0 diff --git a/.github/workflows/main-ci.yml b/.github/workflows/main-ci.yml index 079775a..825f201 100644 --- a/.github/workflows/main-ci.yml +++ b/.github/workflows/main-ci.yml @@ -36,17 +36,17 @@ jobs: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 - name: 📖 Generate documentation - uses: hoverkraft-tech/ci-dokumentor@002e0be35c188aa703fcc656d2db8f128800f723 # 0.1.0 + uses: hoverkraft-tech/ci-dokumentor@4ad2ab669afb9516c4b9d026f093d23350132589 # 0.1.1 with: source: action.yml - - uses: actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b # v2.1.1 + - uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4 id: generate-token with: app-id: ${{ vars.CI_BOT_APP_ID }} private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} - - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0 + - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0 with: github-token: ${{ steps.generate-token.outputs.token }} branch: docs/actions-workflows-documentation-update diff --git a/.github/workflows/need-fix-to-issue.yml b/.github/workflows/need-fix-to-issue.yml index 8d23017..27bd0bb 100644 --- a/.github/workflows/need-fix-to-issue.yml +++ b/.github/workflows/need-fix-to-issue.yml @@ -21,7 +21,7 @@ permissions: jobs: main: - uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0 + uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0 with: manual-commit-ref: ${{ inputs.manual-commit-ref }} manual-base-ref: ${{ inputs.manual-base-ref }} diff --git a/.github/workflows/semantic-pull-request.yml b/.github/workflows/semantic-pull-request.yml index be6f93e..5aa893a 100644 --- a/.github/workflows/semantic-pull-request.yml +++ b/.github/workflows/semantic-pull-request.yml @@ -13,4 +13,4 @@ permissions: jobs: main: - uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0 + uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0 diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index bfb21c2..e106690 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -10,4 +10,4 @@ permissions: jobs: main: - uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@b4883995e100e291a1fed68678d47a560328ed08 # 0.24.0 + uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@d324c777132734fc988c79a74dff3ee0248835fc # 0.25.0 diff --git a/README.md b/README.md index 7050a0b..139f4ed 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Some extra options can be passed to the `docker compose up` command using the `u 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 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. @@ -123,6 +123,8 @@ Some extra options can be passed to the `docker compose down` command using the ## Examples +### Example using in a full workflow + ```yaml name: Docker Compose Action @@ -145,6 +147,8 @@ jobs: docker compose exec test-app pytest ``` +### Example Using environment variables + ```yaml steps: - uses: actions/checkout@v4.2.2 @@ -155,6 +159,8 @@ steps: CUSTOM_VARIABLE: "test" ``` +### Example using `services` + Perform `docker compose up` to some given service instead of all of them ```yaml @@ -169,6 +175,8 @@ steps: helloworld3 ``` +### Example using `up-flags` + Specify flags to pass to the `docker compose up`. Default is none. @@ -177,6 +185,8 @@ Can be used to pass the `--build` flag, for example, if you want persistent volu A full list of flags can be found in the [Docker compose up documentation](https://docs.docker.com/compose/reference/up/). +### Example using `down-flags` + Specify flags to pass to the `docker compose down` command during cleanup. Default is none. @@ -185,6 +195,8 @@ Can be used to pass the want persistent volumes to be deleted as well during cle A full list of flags can be found in the [Docker compose down documentation](https://docs.docker.com/compose/reference/down/). +### 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). diff --git a/action.yml b/action.yml index fd7a953..257cf2f 100644 --- a/action.yml +++ b/action.yml @@ -13,7 +13,7 @@ description: | 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 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.