Compare commits

...

82 Commits
v2.1.0 ... main

Author SHA1 Message Date
hoverkraft-bot[bot]
05da55b2bb docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-01-02 08:49:54 +00:00
dependabot[bot]
d66307f735 chore(deps-dev): bump @ts-dev-tools/core
Bumps the npm-dev-dependencies group with 1 update:
- [@ts-dev-tools/core](https://github.com/escemi-tech/ts-dev-tools).

---
updated-dependencies:
- dependency-name: "@ts-dev-tools/core"
  dependency-version: 1.9.14
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dev-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-01-02 09:45:52 +01:00
dependabot[bot]
d6adfd48d3 chore(deps): bump the github-actions-dependencies group with 8 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Prepare release / release (push) Has been cancelled
Internal - Main - Continuous Integration / prepare-docs (push) Has been cancelled
Internal - Main - Continuous Integration / sync-docs (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 8 updates:

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.21.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml
  dependency-version: 0.21.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml
  dependency-version: 0.31.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml
  dependency-version: 0.31.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.31.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml
  dependency-version: 0.31.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml
  dependency-version: 0.31.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml
  dependency-version: 0.31.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-28 13:31:19 +01:00
hoverkraft-bot[bot]
3086829978 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-12-22 09:56:22 +00:00
hoverkraft-bot[bot]
9dc1f1e6ec ci: prepare release configuration
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-12-22 09:52:44 +00:00
dependabot[bot]
50a58965b3 chore(deps): bump the github-actions-dependencies group across 1 directory with 10 updates
Bumps the github-actions-dependencies group with 10 updates in the / directory:
---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.21.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml
  dependency-version: 0.21.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml
  dependency-version: 0.31.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml
  dependency-version: 0.31.4
  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.2.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.31.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: actions/upload-artifact
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml
  dependency-version: 0.31.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml
  dependency-version: 0.31.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml
  dependency-version: 0.31.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-12-22 10:52:09 +01:00
dependabot[bot]
b7900497f3 chore(deps): bump @actions/core in the actions-dependencies group
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Internal - Main - Continuous Integration / sync-docs (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the actions-dependencies group with 1 update:
- [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core).

---
updated-dependencies:
- dependency-name: "@actions/core"
  dependency-version: 2.0.1
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-12-15 09:05:11 +01:00
dependabot[bot]
089c512a98 chore(deps-dev): bump @ts-dev-tools/core
Some checks failed
Mark stale issues and pull requests / main (push) Has been cancelled
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Internal - Main - Continuous Integration / sync-docs (push) Has been cancelled
Bumps the npm-dev-dependencies group with 1 update:
- [@ts-dev-tools/core](https://github.com/escemi-tech/ts-dev-tools)

Updates `@ts-dev-tools/core` from 1.9.7 to 1.9.11
- [Release notes](https://github.com/escemi-tech/ts-dev-tools/releases)

---
updated-dependencies:
- dependency-name: "@ts-dev-tools/core"
  dependency-version: 1.9.11
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dev-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-05 18:18:50 +01:00
hoverkraft-bot[bot]
b63643de22 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-12-04 16:06:17 +00:00
dependabot[bot]
248470ecc5 chore(deps): bump the github-actions-dependencies group across 1 directory with 10 updates
Bumps the github-actions-dependencies group with 10 updates in the / directory:

Updates `actions/checkout` from 6.0.0 to 6.0.1
Updates `docker/setup-docker-action` from 4.5.0 to 4.6.0
Updates `hoverkraft-tech/ci-github-nodejs` from 0.20.0 to 0.20.6
Updates `hoverkraft-tech/ci-github-common` from 0.30.1 to 0.31.3

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: docker/setup-docker-action
  dependency-version: 4.6.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.20.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml
  dependency-version: 0.20.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml
  dependency-version: 0.31.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml
  dependency-version: 0.31.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.31.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml
  dependency-version: 0.31.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml
  dependency-version: 0.31.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml
  dependency-version: 0.31.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-12-04 16:11:42 +01:00
copilot-swe-agent[bot]
5d59cf29d8 fix: format docker-compose error objects as readable messages
Co-authored-by: neilime <314088+neilime@users.noreply.github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-12-04 15:55:12 +01:00
Emilien Escalle
e9bb59d794 chore: add agents instructions
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-12-04 14:41:44 +01:00
hoverkraft-bot[bot]
6724232075 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-11-22 20:44:01 +00:00
Emilien Escalle
f1193bc509 ci: enable codecov for test coverage
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-11-22 21:38:39 +01:00
dependabot[bot]
175bf4a061 chore(deps): bump the github-actions-dependencies group across 1 directory with 10 updates
Bumps the github-actions-dependencies group with 10 updates in the / directory:

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.20.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml
  dependency-version: 0.20.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml
  dependency-version: 0.30.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml
  dependency-version: 0.30.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: actions/create-github-app-token
  dependency-version: 2.2.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.30.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml
  dependency-version: 0.30.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml
  dependency-version: 0.30.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml
  dependency-version: 0.30.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-11-22 21:32:49 +01:00
dependabot[bot]
9974256204 chore(deps-dev): bump js-yaml from 3.14.1 to 3.14.2
Some checks failed
Mark stale issues and pull requests / main (push) Has been cancelled
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Internal - Main - Continuous Integration / sync-docs (push) Has been cancelled
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.14.1 to 3.14.2.
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/3.14.1...3.14.2)

---
updated-dependencies:
- dependency-name: js-yaml
  dependency-version: 3.14.2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-17 20:05:10 +01:00
dependabot[bot]
2c655a3602 chore(deps): bump @octokit/action from 8.0.2 to 8.0.4
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Internal - Main - Continuous Integration / sync-docs (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps [@octokit/action](https://github.com/octokit/action.js) from 8.0.2 to 8.0.4.
- [Release notes](https://github.com/octokit/action.js/releases)
- [Commits](https://github.com/octokit/action.js/compare/v8.0.2...v8.0.4)

---
updated-dependencies:
- dependency-name: "@octokit/action"
  dependency-version: 8.0.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-05 14:41:08 +01:00
dependabot[bot]
2feed3a086 chore(deps): bump the github-actions-dependencies group with 3 updates
Bumps the github-actions-dependencies group with 3 updates:
- [docker/setup-docker-action](https://github.com/docker/setup-docker-action)
- [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs)
- [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common)

---
updated-dependencies:
- dependency-name: docker/setup-docker-action
  dependency-version: 4.5.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.17.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.28.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-11-05 14:22:40 +01:00
Emilien Escalle
0c4c8ad01b chore: improve devcontainer config
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-11-05 10:29:34 +00:00
Emilien Escalle
0683632a02 chore: improve devcontainer config
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-11-05 10:14:00 +00:00
hoverkraft-bot[bot]
d626027cf5 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-10-31 07:07:24 +00:00
dependabot[bot]
6e0a504521 chore(deps): bump the github-actions-dependencies group with 2 updates
Bumps the github-actions-dependencies group with 2 updates:
- [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs)
- [actions/upload-artifact](https://github.com/actions/upload-artifact)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.16.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
- dependency-name: actions/upload-artifact
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-31 08:03:15 +01:00
dependabot[bot]
ccd64b05f8 chore(deps): bump the github-actions-dependencies group with 3 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 3 updates:
- [docker/setup-docker-action](https://github.com/docker/setup-docker-action)
- [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs)
- [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).

---
updated-dependencies:
- dependency-name: docker/setup-docker-action
  dependency-version: 4.4.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.16.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.27.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-17 09:53:59 +02:00
hoverkraft-bot[bot]
ee80f8a42f docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-10-13 19:23:00 +00:00
Emilien Escalle
3846bcd61d chore: remove useless ghadocs config
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-10-13 21:12:03 +02:00
dependabot[bot]
97c255ba62 chore(deps): bump hoverkraft-tech/ci-github-nodejs
Bumps the github-actions-dependencies group with 1 update:
- [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs).

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.15.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-13 21:11:29 +02:00
dependabot[bot]
8ed9acf0e1 chore(deps): bump hoverkraft-tech/ci-dokumentor
Bumps the github-actions-dependencies group with 1 update:

- [hoverkraft-tech/ci-dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-dokumentor
  dependency-version: 0.2.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-13 20:07:00 +02:00
dependabot[bot]
ef7568e9dc chore(deps): bump the github-actions-dependencies group with 2 updates
Bumps the github-actions-dependencies group with 2 updates:
-[hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common)
- [hoverkraft-tech/ci-dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.26.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.2.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-10-13 18:58:34 +02:00
dependabot[bot]
fff732cbb3 chore(deps-dev): bump the npm-dev-dependencies group across 1 directory with 2 updates
Bumps the npm-dev-dependencies group with 2 updates in the / directory:
- [@ts-dev-tools/core](https://github.com/escemi-tech/ts-dev-tools)
- [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc).

---
updated-dependencies:
- dependency-name: "@ts-dev-tools/core"
  dependency-version: 1.9.7
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dev-dependencies
- dependency-name: eslint-plugin-jsonc
  dependency-version: 2.21.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-dev-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-10-13 18:46:00 +02:00
hoverkraft-bot[bot]
b9f10db4fd docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-30 13:49:33 +00:00
dependabot[bot]
b716db5b71 chore(deps): bump hoverkraft-tech/ci-dokumentor
Bumps the github-actions-dependencies group with 1 update:
[hoverkraft-tech/ci-dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-dokumentor
  dependency-version: 0.1.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-09-30 15:31:16 +02:00
copilot-swe-agent[bot]
88b85ef80e docs: improve compose-flags example
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-09-30 13:11:11 +02:00
dependabot[bot]
ab0fa7d95d chore(deps): bump docker-compose from 1.2.0 to 1.3.0
Bumps [docker-compose](https://github.com/PDMLab/docker-compose) from 1.2.0 to 1.3.0.
- [Changelog](https://github.com/PDMLab/docker-compose/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PDMLab/docker-compose/compare/v1.2.0...v1.3.0)

---
updated-dependencies:
- dependency-name: docker-compose
  dependency-version: 1.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-09-30 13:06:28 +02:00
dependabot[bot]
82f56cc549 chore(deps): bump docker-compose from 1.2.0 to 1.3.0
Bumps [docker-compose](https://github.com/PDMLab/docker-compose) from 1.2.0 to 1.3.0.
- [Changelog](https://github.com/PDMLab/docker-compose/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PDMLab/docker-compose/compare/v1.2.0...v1.3.0)

---
updated-dependencies:
- dependency-name: docker-compose
  dependency-version: 1.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-30 13:06:28 +02:00
dependabot[bot]
650d8e8740 chore(deps-dev): bump the npm-dev-dependencies group across 1 directory with 2 updates
Bumps the npm-dev-dependencies group with 2 updates in the / directory:
[@ts-dev-tools/core](https://github.com/escemi-tech/ts-dev-tools)
and [@vercel/ncc](https://github.com/vercel/ncc).

---
updated-dependencies:
- dependency-name: "@ts-dev-tools/core"
  dependency-version: 1.9.6
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dev-dependencies
- dependency-name: "@vercel/ncc"
  dependency-version: 0.38.4
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dev-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-30 12:56:58 +02:00
dependabot[bot]
b49a5ca3bb 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] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-09-30 12:43:55 +02:00
hoverkraft-bot[bot]
57a2375c11 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-29 19:51:12 +00:00
Emilien Escalle
492e297766 ci: use ci-dokumentor
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-09-29 21:46:55 +02:00
dependabot[bot]
bc82ca5e29 chore(deps): bump the github-actions-dependencies group with 2 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 2 updates: [actions/github-script](https://github.com/actions/github-script) and [actions/publish-action](https://github.com/actions/publish-action).


Updates `actions/github-script` from 7.0.1 to 8.0.0
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](60a0d83039...ed597411d8)

Updates `actions/publish-action` from 0.3.0 to 0.4.0
- [Commits](f784495ce7...23f4c6f126)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: 8.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions-dependencies
- dependency-name: actions/publish-action
  dependency-version: 0.4.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-05 07:09:45 +02:00
dependabot[bot]
8d5a9fea6b chore(deps): bump hoverkraft-tech/ci-github-nodejs
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 1 update: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.14.0 to 0.14.1
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](284b3a2256...1d00c9eb28)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.14.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-22 07:27:25 +02:00
dependabot[bot]
0ec2d95d2f chore(deps-dev): bump @ts-dev-tools/core
Some checks failed
Mark stale issues and pull requests / main (push) Has been cancelled
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Bumps the npm-dev-dependencies group with 1 update: [@ts-dev-tools/core](https://github.com/escemi-tech/ts-dev-tools).


Updates `@ts-dev-tools/core` from 1.6.2 to 1.9.5
- [Release notes](https://github.com/escemi-tech/ts-dev-tools/releases)
- [Commits](https://github.com/escemi-tech/ts-dev-tools/compare/@ts-dev-tools/core@1.6.2...@ts-dev-tools/core@1.9.5)

---
updated-dependencies:
- dependency-name: "@ts-dev-tools/core"
  dependency-version: 1.9.5
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-dev-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-19 18:30:49 +02:00
dependabot[bot]
a5e6b53f31 chore(deps): bump the github-actions-dependencies group with 2 updates
Bumps the github-actions-dependencies group with 2 updates: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs) and [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.13.0 to 0.14.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](51de90c148...284b3a2256)

Updates `hoverkraft-tech/ci-github-common` from 0.23.1 to 0.24.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](6857ef6d10...b4883995e1)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.14.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.24.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-19 15:36:28 +02:00
dependabot[bot]
3b8348c096 chore(deps): bump the github-actions-dependencies group across 1 directory with 4 updates
Bumps the github-actions-dependencies group with 4 updates in the / directory: [actions/checkout](https://github.com/actions/checkout), [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs), [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common) and [actions/create-github-app-token](https://github.com/actions/create-github-app-token).

Updates `actions/checkout` from 4.2.2 to 5.0.0
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](11bd71901b...08c6903cd8)

Updates `hoverkraft-tech/ci-github-nodejs` from 0.12.0 to 0.13.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](77c905a257...51de90c148)

Updates `hoverkraft-tech/ci-github-common` from 0.23.0 to 0.23.1
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](9a3d71ca9f...6857ef6d10)

Updates `actions/create-github-app-token` from 2.0.6 to 2.1.1
- [Release notes](https://github.com/actions/create-github-app-token/releases)
- [Commits](df432ceedc...a8d6161485)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.13.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.23.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.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-08-19 14:41:15 +02:00
dependabot[bot]
1c0bf1362e chore(deps): bump super-linter/super-linter
Bumps the docker-dependencies group with 1 update in the / directory: [super-linter/super-linter](https://github.com/super-linter/super-linter).


Updates `super-linter/super-linter` from slim-v7 to slim-v8
- [Release notes](https://github.com/super-linter/super-linter/releases)
- [Changelog](https://github.com/super-linter/super-linter/blob/main/CHANGELOG.md)
- [Commits](https://github.com/super-linter/super-linter/compare/v7...v8)

---
updated-dependencies:
- dependency-name: super-linter/super-linter
  dependency-version: slim-v8
  dependency-type: direct:production
  dependency-group: docker-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-08-19 14:22:22 +02:00
dependabot[bot]
40041ff1b9 chore(deps): bump hoverkraft-tech/ci-github-common
Some checks failed
Mark stale issues and pull requests / main (push) Has been cancelled
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Bumps the github-actions-dependencies group with 1 update: [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).


Updates `hoverkraft-tech/ci-github-common` from 0.22.3 to 0.23.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](95664be4ec...9a3d71ca9f)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.23.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-06-29 22:30:58 +02:00
hoverkraft-bot[bot]
59a51a1b9c docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-06-23 09:17:31 +00:00
Emilien Escalle
2daef55cd7 chore: branding cleaning
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-06-23 11:12:58 +02:00
Emilien Escalle
4e1d048b27 docs: add example for multiple compose files in README
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-06-20 15:44:17 +02:00
Emilien Escalle
d885714cc1 docs: add example for multiple compose files
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-06-20 12:25:10 +02:00
hoverkraft-bot[bot]
329c851e91 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-06-20 10:12:58 +00:00
Emilien Escalle
213193f269 fix: add missing input in action manifest
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-06-20 12:07:11 +02:00
dvag-gloeckner-daniel
7098fdc4f5 feat: make service log level configurable
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-06-19 13:03:41 +02:00
Emilien Escalle
a035f13e41 feat: upgrade dependencies
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-06-19 12:01:03 +02:00
dependabot[bot]
ad8e0e414a chore(deps): bump @octokit/action from 8.0.1 to 8.0.2
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps [@octokit/action](https://github.com/octokit/action.js) from 8.0.1 to 8.0.2.
- [Release notes](https://github.com/octokit/action.js/releases)
- [Commits](https://github.com/octokit/action.js/compare/v8.0.1...v8.0.2)

---
updated-dependencies:
- dependency-name: "@octokit/action"
  dependency-version: 8.0.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-30 14:04:55 +02:00
dependabot[bot]
15ce64a555 chore(deps): bump hoverkraft-tech/ci-github-nodejs
Bumps the github-actions-dependencies group with 1 update: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.11.0 to 0.12.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](5c1010a914...77c905a257)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.12.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-30 09:51:32 +02:00
dependabot[bot]
c80b846497 chore(deps): bump @octokit/action from 7.0.2 to 8.0.1
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps [@octokit/action](https://github.com/octokit/action.js) from 7.0.2 to 8.0.1.
- [Release notes](https://github.com/octokit/action.js/releases)
- [Commits](https://github.com/octokit/action.js/compare/v7.0.2...v8.0.1)

---
updated-dependencies:
- dependency-name: "@octokit/action"
  dependency-version: 8.0.1
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-23 21:54:42 +02:00
dependabot[bot]
f16481cead chore(deps): bump @actions/github in the actions-dependencies group
Some checks failed
Mark stale issues and pull requests / main (push) Has been cancelled
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Bumps the actions-dependencies group with 1 update: [@actions/github](https://github.com/actions/toolkit/tree/HEAD/packages/github).

Updates `@actions/github` from 6.0.0 to 6.0.1
- [Changelog](https://github.com/actions/toolkit/blob/main/packages/github/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/github)

---
updated-dependencies:
- dependency-name: "@actions/github"
  dependency-version: 6.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-05-11 20:55:02 +02:00
dependabot[bot]
3a740fb279 chore(deps): bump actions/create-github-app-token
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 1 update: [actions/create-github-app-token](https://github.com/actions/create-github-app-token).


Updates `actions/create-github-app-token` from 2.0.3 to 2.0.6
- [Release notes](https://github.com/actions/create-github-app-token/releases)
- [Commits](30bf6253fa...df432ceedc)

---
updated-dependencies:
- dependency-name: actions/create-github-app-token
  dependency-version: 2.0.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-09 07:01:19 +02:00
dependabot[bot]
c4d1d8e06d chore(deps): bump the github-actions-dependencies group across 1 directory with 3 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 3 updates in the / directory: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs), [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common) and [actions/create-github-app-token](https://github.com/actions/create-github-app-token).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.10.0 to 0.11.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](0c281f43dd...5c1010a914)

Updates `hoverkraft-tech/ci-github-common` from 0.22.2 to 0.22.3
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](abd5469ef9...95664be4ec)

Updates `actions/create-github-app-token` from 2.0.2 to 2.0.3
- [Release notes](https://github.com/actions/create-github-app-token/releases)
- [Commits](3ff1caaa28...30bf6253fa)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-version: 0.11.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.22.3
  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.0.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-02 07:47:40 +02:00
Emilien Escalle
0544eebad5 chore: fix ci
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-05-02 07:36:07 +02:00
dependabot[bot]
3212ac38f2 chore(deps): bump hoverkraft-tech/ci-github-common
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 1 update: [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).


Updates `hoverkraft-tech/ci-github-common` from 0.22.0 to 0.22.2
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](198d391bd7...abd5469ef9)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-version: 0.22.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-18 07:45:55 +02:00
dependabot[bot]
39497ec4dd chore(deps): bump @octokit/action from 7.0.1 to 7.0.2
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps [@octokit/action](https://github.com/octokit/action.js) from 7.0.1 to 7.0.2.
- [Release notes](https://github.com/octokit/action.js/releases)
- [Commits](https://github.com/octokit/action.js/compare/v7.0.1...v7.0.2)

---
updated-dependencies:
- dependency-name: "@octokit/action"
  dependency-version: 7.0.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-11 07:24:39 +02:00
dependabot[bot]
29a0d4b13c chore(deps): bump actions/create-github-app-token
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Need fix to Issue / main (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 1 update: [actions/create-github-app-token](https://github.com/actions/create-github-app-token).


Updates `actions/create-github-app-token` from 1.12.0 to 2.0.2
- [Release notes](https://github.com/actions/create-github-app-token/releases)
- [Commits](d72941d797...3ff1caaa28)

---
updated-dependencies:
- dependency-name: actions/create-github-app-token
  dependency-version: 2.0.2
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-04-04 09:18:36 +02:00
dependabot[bot]
547846f8fb chore(deps): bump the github-actions-dependencies group with 2 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Mark stale issues and pull requests / main (push) Has been cancelled
Bumps the github-actions-dependencies group with 2 updates: [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common) and [actions/create-github-app-token](https://github.com/actions/create-github-app-token).


Updates `hoverkraft-tech/ci-github-common` from 0.20.0 to 0.22.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](edc1e53751...198d391bd7)

Updates `actions/create-github-app-token` from 1.11.7 to 1.12.0
- [Release notes](https://github.com/actions/create-github-app-token/releases)
- [Commits](af35edadc0...d72941d797)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: actions/create-github-app-token
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-28 07:06:45 +01:00
Emilien Escalle
14ab51d9bf feat: upgrade dependencies
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / release (push) Has been cancelled
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-03-26 19:37:07 +01:00
dependabot[bot]
714591cd55 chore(deps): bump docker-compose from 1.1.1 to 1.2.0
Bumps [docker-compose](https://github.com/PDMLab/docker-compose) from 1.1.1 to 1.2.0.
- [Changelog](https://github.com/PDMLab/docker-compose/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PDMLab/docker-compose/compare/v1.1.1...v1.2.0)

---
updated-dependencies:
- dependency-name: docker-compose
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-03-26 19:13:18 +01:00
dependabot[bot]
86e13c8bea chore(deps): bump the github-actions-dependencies group with 2 updates
Bumps the github-actions-dependencies group with 2 updates: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs) and [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).

Updates `hoverkraft-tech/ci-github-nodejs` from 0.9.0 to 0.10.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-nodejs/compare/0.9.0...0.10.0)

Updates `hoverkraft-tech/ci-github-common` from 0.18.0 to 0.20.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-common/compare/0.18.0...0.20.0)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-03-26 19:02:19 +01:00
dependabot[bot]
1d127c94a3 chore(deps): bump the github-actions-dependencies group with 2 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Bumps the github-actions-dependencies group with 2 updates: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs) and [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.8.1 to 0.9.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-nodejs/compare/0.8.1...0.9.0)

Updates `hoverkraft-tech/ci-github-common` from 0.17.0 to 0.18.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-common/compare/0.17.0...0.18.0)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-21 10:59:34 +01:00
dependabot[bot]
47ef9a3b5f chore(deps): bump hoverkraft-tech/ci-github-nodejs
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Bumps the github-actions-dependencies group with 1 update: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.8.0 to 0.8.1
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-nodejs/compare/0.8.0...0.8.1)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-02-28 07:56:09 +01:00
Emilien Escalle
63b042489c ci: add docker-compose to dependencies update
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-02-25 20:53:00 +01:00
dependabot[bot]
391b044006 chore(deps): bump @octokit/action from 7.0.0 to 7.0.1
Some checks are pending
Internal - Main - Continuous Integration / ci (push) Waiting to run
Internal - Main - Continuous Integration / generate-readme (push) Blocked by required conditions
Bumps [@octokit/action](https://github.com/octokit/action.js) from 7.0.0 to 7.0.1.
- [Release notes](https://github.com/octokit/action.js/releases)
- [Commits](https://github.com/octokit/action.js/compare/v7.0.0...v7.0.1)

---
updated-dependencies:
- dependency-name: "@octokit/action"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-02-21 07:34:17 +01:00
dependabot[bot]
2799547b71 chore(deps): bump docker-compose from 1.1.0 to 1.1.1
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Bumps [docker-compose](https://github.com/PDMLab/docker-compose) from 1.1.0 to 1.1.1.
- [Changelog](https://github.com/PDMLab/docker-compose/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PDMLab/docker-compose/compare/v1.1.0...v1.1.1)

---
updated-dependencies:
- dependency-name: docker-compose
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-02-14 14:01:22 +01:00
dependabot[bot]
f9146533dc chore(deps): bump hoverkraft-tech/ci-github-common
Bumps the github-actions-dependencies group with 1 update: [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).


Updates `hoverkraft-tech/ci-github-common` from 0.16.1 to 0.17.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-common/compare/0.16.1...0.17.0)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-02-14 08:43:39 +01:00
Emilien Escalle
969f2aa45e ci: add Release new action version workflow
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-02-05 10:39:54 +01:00
dependabot[bot]
8be2d741e8 chore(deps): bump the github-actions-dependencies group with 2 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Bumps the github-actions-dependencies group with 2 updates: [hoverkraft-tech/ci-github-nodejs](https://github.com/hoverkraft-tech/ci-github-nodejs) and [hoverkraft-tech/ci-github-common](https://github.com/hoverkraft-tech/ci-github-common).


Updates `hoverkraft-tech/ci-github-nodejs` from 0.7.0 to 0.8.0
- [Release notes](https://github.com/hoverkraft-tech/ci-github-nodejs/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-nodejs/compare/0.7.0...0.8.0)

Updates `hoverkraft-tech/ci-github-common` from 0.16.0 to 0.16.1
- [Release notes](https://github.com/hoverkraft-tech/ci-github-common/releases)
- [Commits](https://github.com/hoverkraft-tech/ci-github-common/compare/0.16.0...0.16.1)

---
updated-dependencies:
- dependency-name: hoverkraft-tech/ci-github-nodejs
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github-actions-dependencies
- dependency-name: hoverkraft-tech/ci-github-common
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-01-30 21:14:11 +01:00
github-actions[bot]
d98be6ed72 docs: update actions and workflows documentation
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-01-30 20:05:22 +00:00
Emilien Escalle
2c587abdb1 feat: add docker flags input
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-01-30 20:58:36 +01:00
Emilien Escalle
5bc973d473 fix: npm security issue 2025-01-30 20:58:36 +01:00
Emilien Escalle
99765016ef docs; use docker compose wording instead of docker-compose 2025-01-30 20:58:36 +01:00
Emilien Escalle
0807b14987 fix: print docker compose output to debug only
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-01-30 20:45:35 +01:00
Emilien Escalle
765986dd3e
docs: add ref link to debug mode
Some checks are pending
Internal - Main - Continuous Integration / ci (push) Waiting to run
Internal - Main - Continuous Integration / generate-readme (push) Blocked by required conditions
Signed-off-by: Emilien Escalle <neilime@users.noreply.github.com>
2025-01-30 10:04:38 +01:00
dependabot[bot]
ad6e7b37dc chore(deps): bump the actions-dependencies group across 1 directory with 2 updates
Some checks failed
Internal - Main - Continuous Integration / ci (push) Has been cancelled
Internal - Main - Continuous Integration / generate-readme (push) Has been cancelled
Bumps the actions-dependencies group with 2 updates in the / directory: [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) and [@actions/tool-cache](https://github.com/actions/toolkit/tree/HEAD/packages/tool-cache).

Updates `@actions/core` from 1.10.1 to 1.11.1
- [Changelog](https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/core)

Updates `@actions/tool-cache` from 2.0.1 to 2.0.2
- [Changelog](https://github.com/actions/toolkit/blob/main/packages/tool-cache/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/tool-cache)

---
updated-dependencies:
- dependency-name: "@actions/core"
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: actions-dependencies
- dependency-name: "@actions/tool-cache"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
2025-01-20 17:44:50 +01:00
53 changed files with 37058 additions and 6430 deletions

View File

@ -1,41 +1,29 @@
{ {
"name": "GitHub Actions (TypeScript)", "name": "Debian",
"image": "mcr.microsoft.com/devcontainers/typescript-node:20", "image": "mcr.microsoft.com/devcontainers/base:bullseye",
"postCreateCommand": "npm install", "features": {
"customizations": { "ghcr.io/devcontainers/features/node:1": {},
"codespaces": { "ghcr.io/devcontainers/features/docker-in-docker:2": {},
"openFiles": ["README.md"] "ghcr.io/devcontainers/features/github-cli:1": {}
},
"vscode": {
"extensions": [
"bierner.markdown-preview-github-styles",
"davidanson.vscode-markdownlint",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"github.copilot",
"github.copilot-chat",
"github.vscode-github-actions",
"github.vscode-pull-request-github",
"me-dutour-mathieu.vscode-github-actions",
"redhat.vscode-yaml",
"rvest.vs-code-prettier-eslint",
"yzhang.markdown-all-in-one"
],
"settings": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.tabSize": 2,
"editor.formatOnSave": true,
"markdown.extension.list.indentationSize": "adaptive",
"markdown.extension.italic.indicator": "_",
"markdown.extension.orderedList.marker": "one"
}
}
}, },
"remoteEnv": { "remoteEnv": {
"GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}" "GITHUB_TOKEN": "${localEnv:GITHUB_TOKEN}"
}, },
"features": { "customizations": {
"ghcr.io/devcontainers/features/github-cli:1": {}, "vscode": {
"ghcr.io/devcontainers-contrib/features/prettier:1": {} "extensions": [
"eamodio.gitlens",
"github.copilot",
"github.copilot-chat",
"github.vscode-github-actions",
"ms-vscode.makefile-tools",
"bierner.markdown-preview-github-styles",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
],
"settings": {
"terminal.integrated.defaultProfile.linux": "zsh"
}
}
} }
} }

View File

@ -1,17 +0,0 @@
{
"paths": {
"action": "action.yml",
"readme": "README.md"
},
"show_logo": true,
"versioning": {
"enabled": true,
"override": "",
"prefix": "v",
"branch": "main"
},
"owner": "hoverkraft-tech",
"repo": "compose-action",
"title_prefix": "GitHub Action: ",
"prettier": true
}

View File

@ -26,17 +26,37 @@ updates:
patterns: patterns:
- "*" - "*"
- package-ecosystem: npm - package-ecosystem: docker-compose
directory: "/" directory: "/test"
open-pull-requests-limit: 20 open-pull-requests-limit: 20
versioning-strategy: widen
schedule: schedule:
interval: weekly interval: weekly
day: friday day: friday
time: "04:00" time: "04:00"
groups: groups:
docker-compose-dependencies:
patterns:
- "*"
- package-ecosystem: npm
directory: "/"
open-pull-requests-limit: 20
versioning-strategy: increase
schedule:
interval: weekly
day: friday
time: "04:00"
groups:
npm-dev-dependencies:
dependency-type: development
actions-dependencies: actions-dependencies:
patterns: patterns:
- "@actions/*" - "@actions/*"
npm-dev-dependencies:
dependency-type: development - package-ecosystem: "devcontainers"
open-pull-requests-limit: 20
directory: "/"
schedule:
interval: weekly
day: friday
time: "04:00"

View File

@ -1,6 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" width="43%" height="43%" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" style="color: #ffffff;">
<title>anchor</title>
<circle cx="12" cy="5" r="3"></circle>
<line x1="12" y1="22" x2="12" y2="8"></line>
<path d="M5 12H2a10 10 0 0 0 20 0h-3"></path>
</svg>

Before

Width:  |  Height:  |  Size: 382 B

View File

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

View File

@ -1,16 +0,0 @@
<!-- markdownlint-disable-next-line 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
```

View File

@ -1,7 +0,0 @@
<!-- markdownlint-disable-next-line 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/).

View File

@ -1,8 +0,0 @@
<!-- markdownlint-disable-next-line 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/).

View File

@ -1,18 +0,0 @@
<!-- markdownlint-disable-next-line 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
```

3
.github/linters/.jscpd.json vendored Normal file
View File

@ -0,0 +1,3 @@
{
"ignore": ["**/dist/**", "**/node_modules/**", "**/coverage/**"]
}

67
.github/logo.svg vendored Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 3.5 MiB

30
.github/release-config.yml vendored Normal file
View File

@ -0,0 +1,30 @@
---
template: |
# What's Changed
$CHANGES
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...$RESOLVED_VERSION
name-template: "Version $RESOLVED_VERSION"
tag-template: "$RESOLVED_VERSION"
tag-prefix: ""
prerelease-identifier: "rc"
version-resolver:
major:
labels:
- "release-major"
minor:
labels:
- "release-minor"
patch:
labels:
- "release-patch"
default: patch
autolabeler:
- label: "release-major"
title:
- "/^BREAKING CHANGE:/"
- "/^\\w+!:/"
- "/^\\w+\\(.+\\)!:/"
- label: "release-minor"
title:
- "/^feat:/"
- "/^feat\\(.+\\):/"

24479
.github/social-preview.svg vendored Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 3.5 MiB

View File

@ -3,223 +3,194 @@ name: Internal - Tests for action
on: on:
workflow_call: workflow_call:
permissions: permissions: {}
contents: read
jobs: jobs:
test-action-with-services: test-action:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: Test with services name: ${{ matrix.name }} - ${{ matrix.assertion-name }}
steps: permissions:
- uses: actions/checkout@v4 contents: read
strategy:
fail-fast: false
matrix:
include:
- name: Given multiple services when filtering services
assertion-name: "Then only expected services run"
compose-file: ./test/docker-compose.yml
services: |
service-b
service-c
assertion: |
docker compose -f ./test/docker-compose.yml ps
- name: Act docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1)
uses: ./ docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 || (echo "Service service-c is not running" && exit 1)
with: (docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true
compose-file: "./test/docker-compose.yml"
services: |
service-b
service-c
- name: "Assert: only expected services are running" - name: Given compose file when applying down flags
run: | assertion-name: "Then teardown honors down flags"
docker compose -f ./test/docker-compose.yml ps compose-file: ./test/docker-compose.yml
down-flags: "--volumes"
assertion: |
docker compose -f ./test/docker-compose.yml ps
docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1) docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 || (echo "Service service-a is not running" && exit 1)
docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 || (echo "Service service-c is not running" && exit 1) (docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 && echo "Service service-b should not be running without profile" && exit 1) || true
(docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true (docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 && echo "Service service-c should not be running without profile" && exit 1) || true
test-action-with-down-flags: - name: Given compose profile when passing compose flags
runs-on: ubuntu-latest assertion-name: "Then the requested profile is active"
name: Test compose action compose-file: ./test/docker-compose.yml
steps: compose-flags: "--profile profile-1"
- uses: actions/checkout@v4 down-flags: "--volumes"
assertion: |
docker compose -f ./test/docker-compose.yml -p profile-1 ps || (echo "Profile not used" && exit 1)
- name: Act - name: Given image supplied via env when running action
uses: ./ assertion-name: "Then compose uses the provided env"
with: compose-file: ./test/docker-compose-with-env.yml
compose-file: "./test/docker-compose.yml" image-name: busybox
down-flags: "--volumes" assertion: |
docker compose -f ./test/docker-compose-with-env.yml ps
test-action-with-compose-flags: docker compose -f ./test/docker-compose-with-env.yml ps | grep test-service-a-1 || (echo "Service service-a is not running" && exit 1)
runs-on: ubuntu-latest
name: Test with compose flags
steps:
- uses: actions/checkout@v4
- name: Act - name: Given multiple compose files when selecting services
uses: ./ assertion-name: "Then only services from selection run"
with: compose-file: |
compose-file: "./test/docker-compose.yml" ./test/docker-compose.yml
compose-flags: "--profile profile-1" ./test/docker-compose.ci.yml
down-flags: "--volumes" services: |
service-b
service-d
assertion: |
docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps
- name: "Assert: profile is used" docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1)
run: | docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-d-1 || (echo "Service service-d is not running" && exit 1)
docker compose -f ./test/docker-compose.yml -p profile-1 ps || (echo "Profile not used" && exit 1) (docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true
(docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-c-1 && echo "Unexpected service service-c is running" && exit 1) || true
test-action-with-env: - name: Given compose file in subdirectory when setting cwd
runs-on: ubuntu-latest assertion-name: "Then only expected services run"
name: Test with env compose-file: docker-compose.yml
steps: cwd: ./test
- uses: actions/checkout@v4 services: |
service-b
service-c
assertion: |
docker compose -f ./test/docker-compose.yml ps
- name: Act docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1)
uses: ./ docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 || (echo "Service service-c is not running" && exit 1)
with: (docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true
compose-file: "./test/docker-compose-with-env.yml"
env:
IMAGE_NAME: busybox
- name: "Assert: env is used" - name: Given absolute compose path when running action
env: assertion-name: "Then only expected services run"
IMAGE_NAME: busybox compose-file: test/docker-compose.yml
run: | use-absolute-path: true
docker compose -f ./test/docker-compose-with-env.yml ps services: |
service-b
service-c
assertion: |
docker compose -f ./test/docker-compose.yml ps
docker compose -f ./test/docker-compose-with-env.yml ps | grep test-service-a-1 || (echo "Service service-a is not running" && exit 1) docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1)
docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 || (echo "Service service-c is not running" && exit 1)
(docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true
test-action-with-multiple-compose-files: - name: Given compose with multiple services when using abort-on-container-exit
runs-on: ubuntu-latest assertion-name: "Then execution stops on container exit"
name: Test with multiple compose files compose-file: test/docker-compose-web-mysql.yml
steps: up-flags: "--build --abort-on-container-exit --exit-code-from=web"
- uses: actions/checkout@v4 assertion: |
WEB_EXIT_CODE=$(docker compose -f ./test/docker-compose-web-mysql.yml ps web --all --format json | jq ".ExitCode")
[ "$WEB_EXIT_CODE" == "0" ] || (echo "Web service did not exit successfully" && exit 1)
- name: Act MYSQL_STATE=$(docker compose -f ./test/docker-compose-web-mysql.yml ps mysql --all --format json | jq -r ".State")
uses: ./ if [ "$MYSQL_STATE" = "running" ]; then
with: echo "MySQL service is still running"
compose-file: | exit 1
./test/docker-compose.yml fi
./test/docker-compose.ci.yml
services: |
service-b
service-d
- name: "Assert: only expected services are running" - name: Given failing dependency when attaching dependencies
run: | assertion-name: "Then failing service exits with code 1"
docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps compose-file: test/docker-compose-fail.yml
up-flags: "--attach-dependencies"
assertion: |
EXIT_CODE=$(docker compose -f ./test/docker-compose-fail.yml ps service-a --all --format json | jq ".ExitCode")
[ "$EXIT_CODE" == "1" ] || (echo "Service service-a did not exit with code 1" && exit 1)
docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1) - name: Given compose version mismatch when requesting explicit version
docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-d-1 || (echo "Service service-d is not running" && exit 1) assertion-name: "Then docker compose reports the requested version"
(docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true compose-file: ./test/docker-compose.yml
(docker compose -f ./test/docker-compose.yml -f ./test/docker-compose.ci.yml ps | grep test-service-c-1 && echo "Unexpected service service-c is running" && exit 1) || true compose-version: "2.29.0"
expected-compose-version: "2.29.0"
ensure-version-mismatch: true
assertion: |
CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short)
echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION"
test-action-with-cwd: if [ "$CURRENT_DOCKER_COMPOSE_VERSION" != "$DOCKER_COMPOSE_VERSION" ]; then
runs-on: ubuntu-latest echo "Docker compose version is not in $DOCKER_COMPOSE_VERSION version"
name: Test with cwd exit 1
steps: fi
- uses: actions/checkout@v4
- name: Act - name: Given compose version mismatch when requesting latest version
uses: ./ assertion-name: "Then docker compose reports the requested version"
with: compose-file: ./test/docker-compose.yml
compose-file: "docker-compose.yml" compose-version: latest
cwd: "./test" fetch-latest-compose: true
services: | ensure-version-mismatch: true
service-b assertion: |
service-c CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short)
echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION"
- name: "Assert: only expected services are running" if [ "$CURRENT_DOCKER_COMPOSE_VERSION" != "$DOCKER_COMPOSE_VERSION" ]; then
run: | echo "Docker compose version is not in $DOCKER_COMPOSE_VERSION version"
docker compose -f ./test/docker-compose.yml ps exit 1
fi
docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1) - name: Given custom docker context when providing docker flags
docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 || (echo "Service service-c is not running" && exit 1) assertion-name: "Then docker compose uses that context"
(docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true compose-file: ./test/docker-compose.yml
compose-version: latest
docker-flags: "--context test-context"
docker-context: test-context
assertion: |
CURRENT_CONTEXT=$(docker context show)
if [ "$CURRENT_CONTEXT" != "test-context" ]; then
echo "Docker context is '$CURRENT_CONTEXT' instead of 'test-context'"
exit 1
fi
test-action-with-absolute-path: docker compose -f ./test/docker-compose.yml ps
runs-on: ubuntu-latest
name: Test with absolute path
steps:
- uses: actions/checkout@v4
- name: Act docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 || (echo "Service service-a is not running under custom context" && exit 1)
uses: ./ (docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 && echo "Service service-b should not be running without profile" && exit 1) || true
with:
compose-file: "${{ github.workspace }}/test/docker-compose.yml"
services: |
service-b
service-c
- name: "Assert: only expected services are running"
run: |
docker compose -f ./test/docker-compose.yml ps
docker compose -f ./test/docker-compose.yml ps | grep test-service-b-1 || (echo "Service service-b is not running" && exit 1)
docker compose -f ./test/docker-compose.yml ps | grep test-service-c-1 || (echo "Service service-c is not running" && exit 1)
(docker compose -f ./test/docker-compose.yml ps | grep test-service-a-1 && echo "Unexpected service service-a is running" && exit 1) || true
test-abort-on-container-exit:
runs-on: ubuntu-latest
name: Test with --abort-on-container-exit
steps:
- uses: actions/checkout@v4
- name: Act
uses: ./
with:
compose-file: "test/docker-compose-web-mysql.yml"
up-flags: "--build --abort-on-container-exit --exit-code-from=web"
test-attach-dependencies-failure:
runs-on: ubuntu-latest
name: Test with --attach-dependencies and service failure
steps:
- uses: actions/checkout@v4
- name: Act
uses: ./
with:
compose-file: "test/docker-compose-fail.yml"
up-flags: "--attach-dependencies"
- name: Assert
run: |
EXIT_CODE=$(docker compose -f ./test/docker-compose-fail.yml ps service-a --all --format json | jq ".ExitCode")
[ "$EXIT_CODE" == "1" ] || (echo "Service service-a did not exit with code 1" && exit 1)
test-action-with-compose-version:
runs-on: ubuntu-latest
name: Test with compose version
env: env:
DOCKER_COMPOSE_VERSION: "2.29.0" DOCKER_COMPOSE_VERSION: ${{ matrix.expected-compose-version || '' }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: "Arrange: ensure original docker compose version is not the expected one"
run: |
CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short)
echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION"
if [ "$CURRENT_DOCKER_COMPOSE_VERSION" == "$DOCKER_COMPOSE_VERSION" ]; then
echo "Docker compose version is already in $DOCKER_COMPOSE_VERSION version"
exit 1
fi
- name: Act
uses: ./
with: with:
compose-file: "./test/docker-compose.yml" persist-credentials: false
compose-version: "2.29.0"
- name: "Assert: compose version is used" - name: Set up Docker context
run: | if: ${{ matrix.docker-context }}
CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short) uses: docker/setup-docker-action@e61617a16c407a86262fb923c35a616ddbe070b3 # v4.6.0
echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION" with:
context: ${{ matrix.docker-context }}
if [ "$CURRENT_DOCKER_COMPOSE_VERSION" != "$DOCKER_COMPOSE_VERSION" ]; then - name: Resolve absolute compose path
echo "Docker compose version is not in $DOCKER_COMPOSE_VERSION version" if: ${{ matrix.use-absolute-path }}
exit 1 id: compose-path
fi run: echo "absolute=${GITHUB_WORKSPACE}/${{ matrix.compose-file }}" >> "$GITHUB_OUTPUT"
test-action-with-compose-version-latest:
runs-on: ubuntu-latest
name: Test with compose version latest
steps:
- uses: actions/checkout@v4
- name: "Arrange: retrieve latest version of docker compose" - name: "Arrange: retrieve latest version of docker compose"
uses: actions/github-script@v7 if: ${{ matrix.fetch-latest-compose }}
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
with: with:
script: | script: |
const dockerComposeVersion = (await github.rest.repos.getLatestRelease({ const dockerComposeVersion = (await github.rest.repos.getLatestRelease({
@ -230,6 +201,7 @@ jobs:
core.exportVariable('DOCKER_COMPOSE_VERSION', dockerComposeVersion); core.exportVariable('DOCKER_COMPOSE_VERSION', dockerComposeVersion);
- name: "Arrange: ensure original docker compose version is not the expected one" - name: "Arrange: ensure original docker compose version is not the expected one"
if: ${{ matrix.ensure-version-mismatch }}
run: | run: |
CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short) CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short)
echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION" echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION"
@ -242,15 +214,19 @@ jobs:
- name: Act - name: Act
uses: ./ uses: ./
with: with:
compose-file: "./test/docker-compose.yml" compose-file: ${{ matrix.use-absolute-path && steps.compose-path.outputs.absolute || matrix.compose-file }}
compose-version: "latest" services: ${{ matrix.services || '' }}
down-flags: ${{ matrix.down-flags || '' }}
compose-flags: ${{ matrix.compose-flags || '' }}
compose-version: ${{ matrix.compose-version || '' }}
cwd: ${{ matrix.cwd || '' }}
up-flags: ${{ matrix.up-flags || '' }}
docker-flags: ${{ matrix.docker-flags || '' }}
env:
IMAGE_NAME: ${{ matrix.image-name || '' }}
- name: "Assert: compose version is used" - name: ${{ matrix.assertion-name }}
run: | if: ${{ matrix.assertion }}
CURRENT_DOCKER_COMPOSE_VERSION=$(docker compose version --short) run: ${{ matrix.assertion }}
echo "Current docker compose version: $CURRENT_DOCKER_COMPOSE_VERSION" env:
IMAGE_NAME: ${{ matrix.image-name || '' }}
if [ "$CURRENT_DOCKER_COMPOSE_VERSION" != "$DOCKER_COMPOSE_VERSION" ]; then
echo "Docker compose version is not in $DOCKER_COMPOSE_VERSION version"
exit 1
fi

View File

@ -3,20 +3,25 @@ name: Internal - Checks for dist
on: on:
workflow_call: workflow_call:
permissions: permissions: {}
contents: read
jobs: jobs:
check-dist: check-dist:
name: Check dist name: Check dist
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: read
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@0.7.0 with:
persist-credentials: false
- id: setup-node
uses: hoverkraft-tech/ci-github-nodejs/actions/setup-node@c9d9d041ba4ef35695ee469c4782fa6a8bbebbcc # 0.21.2
- name: Build dist/ Directory - name: Build dist/ Directory
id: package id: package
run: npm run package run: ${{ steps.setup-node.outputs.run-script-command }} package
# This will fail the workflow if the PR wasn't created by Dependabot. # This will fail the workflow if the PR wasn't created by Dependabot.
- name: Compare Directories - name: Compare Directories
@ -27,13 +32,3 @@ jobs:
git diff --ignore-space-at-eol --text dist/ git diff --ignore-space-at-eol --text dist/
exit 1 exit 1
fi fi
# If `dist/` was different than expected, and this was not a Dependabot
# PR, upload the expected version as a workflow artifact.
- if: ${{ failure() && steps.diff.outcome == 'failure' }}
name: Upload Artifact
id: upload
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/

View File

@ -3,17 +3,18 @@ name: Internal - Checks for nodejs
on: on:
workflow_call: workflow_call:
permissions: permissions: {}
contents: read
security-events: write
id-token: write
jobs: jobs:
test-nodejs: test-nodejs:
uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@0.7.0 uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/continuous-integration.yml@c9d9d041ba4ef35695ee469c4782fa6a8bbebbcc # 0.21.2
permissions: permissions:
id-token: write
security-events: write
contents: read contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
with: with:
build: "" build: ""
test: |
{"coverage":"codecov"}

View File

@ -3,16 +3,16 @@ name: Common Continuous Integration tasks
on: on:
workflow_call: workflow_call:
permissions: permissions: {}
contents: read
packages: read
statuses: write
security-events: write
id-token: write
jobs: jobs:
linter: linter:
uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@0.16.0 uses: hoverkraft-tech/ci-github-common/.github/workflows/linter.yml@b17226e57c8ef31f860719766656ebb6df017218 # 0.31.6
permissions:
actions: read
contents: read
security-events: write
statuses: write
with: with:
linter-env: | linter-env: |
FILTER_REGEX_EXCLUDE=dist/**/* FILTER_REGEX_EXCLUDE=dist/**/*
@ -27,14 +27,24 @@ jobs:
name: Test nodejs name: Test nodejs
needs: linter needs: linter
uses: ./.github/workflows/__check-nodejs.yml uses: ./.github/workflows/__check-nodejs.yml
permissions:
contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
secrets: inherit secrets: inherit
check-dist: check-dist:
name: Test nodejs name: Test nodejs
needs: linter needs: linter
uses: ./.github/workflows/__check-dist.yml uses: ./.github/workflows/__check-dist.yml
permissions:
contents: read
check-action: check-action:
name: Test action name: Test action
needs: [check-nodejs, check-dist] needs: [check-nodejs, check-dist]
uses: ./.github/workflows/__check-action.yml uses: ./.github/workflows/__check-action.yml
permissions:
contents: read

View File

@ -6,11 +6,12 @@ on:
pull_request_target: pull_request_target:
branches: [main] branches: [main]
permissions: permissions: {}
contents: read
issues: write
pull-requests: write
jobs: jobs:
greetings: greetings:
uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@0.16.0 uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@b17226e57c8ef31f860719766656ebb6df017218 # 0.31.6
permissions:
contents: read
issues: write
pull-requests: write

View File

@ -5,39 +5,64 @@ on:
branches: [main] branches: [main]
tags: ["*"] tags: ["*"]
permissions: workflow_dispatch:
contents: read
packages: read schedule:
statuses: write - cron: "25 8 * * 1"
security-events: write
id-token: write
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true cancel-in-progress: true
permissions: {}
jobs: jobs:
ci: ci:
uses: ./.github/workflows/__shared-ci.yml uses: ./.github/workflows/__shared-ci.yml
permissions:
actions: read
contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
statuses: write
secrets: inherit secrets: inherit
generate-readme: prepare-docs:
needs: ci needs: ci
if: github.event_name != 'schedule'
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: read
outputs:
artifact-id: ${{ steps.upload-artifact.outputs.artifact-id }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- uses: bitflight-devops/github-action-readme-generator@v1.8.0
with: with:
owner: hoverkraft-tech persist-credentials: false
repo: compose-action
- uses: actions/create-github-app-token@v1 - name: 📖 Generate documentation
id: generate-documentation
uses: hoverkraft-tech/ci-dokumentor@c46a1a108957237cf485103a80b060c35c7dba33 # 0.2.2
with:
source: action.yml
extra-badges: |
[
{
"label":"codecov",
"url":"https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA",
"linkUrl":"https://codecov.io/gh/hoverkraft-tech/compose-action"
}
]
- uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2.2.1
id: generate-token id: generate-token
with: with:
app-id: ${{ vars.CI_BOT_APP_ID }} app-id: ${{ vars.CI_BOT_APP_ID }}
private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }} private-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }}
- uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@0.16.0 - uses: hoverkraft-tech/ci-github-common/actions/create-and-merge-pull-request@b17226e57c8ef31f860719766656ebb6df017218 # 0.31.6
with: with:
github-token: ${{ steps.generate-token.outputs.token }} github-token: ${{ steps.generate-token.outputs.token }}
branch: docs/actions-workflows-documentation-update branch: docs/actions-workflows-documentation-update
@ -47,3 +72,23 @@ jobs:
docs: update actions and workflows documentation docs: update actions and workflows documentation
[skip ci] [skip ci]
- id: upload-artifact
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: documentation-files-${{ github.run_id }}
path: |
${{ steps.generate-documentation.outputs.destination }}
.github/logo.svg
sync-docs:
needs: prepare-docs
if: needs.prepare-docs.outputs.artifact-id
uses: hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
permissions:
contents: read
with:
artifact-id: ${{ needs.prepare-docs.outputs.artifact-id }}
github-app-id: ${{ vars.CI_BOT_APP_ID }}
secrets:
github-app-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }}

View File

@ -15,13 +15,14 @@ on:
before it; to go back further, enter an earlier SHA here" before it; to go back further, enter an earlier SHA here"
required: false required: false
permissions: permissions: {}
contents: read
issues: write
jobs: jobs:
main: main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@0.16.0 uses: hoverkraft-tech/ci-github-common/.github/workflows/need-fix-to-issue.yml@b17226e57c8ef31f860719766656ebb6df017218 # 0.31.6
permissions:
contents: read
issues: write
with: with:
manual-commit-ref: ${{ inputs.manual-commit-ref }} manual-commit-ref: ${{ inputs.manual-commit-ref }}
manual-base-ref: ${{ inputs.manual-base-ref }} manual-base-ref: ${{ inputs.manual-base-ref }}

26
.github/workflows/prepare-release.yml vendored Normal file
View File

@ -0,0 +1,26 @@
---
name: "Prepare release"
on:
push:
branches: [main]
pull_request:
types: [opened, reopened, synchronize]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions: {}
jobs:
release:
uses: hoverkraft-tech/ci-github-publish/.github/workflows/prepare-release.yml@84e8ace407055e7a40ba6670a8c697e1ce2dfafa # 0.20.1
permissions:
contents: write
id-token: write
pull-requests: write
with:
github-app-id: ${{ vars.CI_BOT_APP_ID }}
secrets:
github-app-key: ${{ secrets.CI_BOT_APP_PRIVATE_KEY }}

View File

@ -5,12 +5,7 @@ on:
pull_request: pull_request:
branches: [main] branches: [main]
permissions: permissions: {}
contents: read
packages: read
statuses: write
security-events: write
id-token: write
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}
@ -19,4 +14,12 @@ concurrency:
jobs: jobs:
ci: ci:
uses: ./.github/workflows/__shared-ci.yml uses: ./.github/workflows/__shared-ci.yml
permissions:
actions: read
contents: read
id-token: write
packages: read
pull-requests: write
security-events: write
statuses: write
secrets: inherit secrets: inherit

View File

@ -0,0 +1,30 @@
name: Release new action version
on:
release:
types: [released]
workflow_dispatch:
inputs:
#checkov:skip=CKV_GHA_7: required
TAG_NAME:
description: "Tag name that the major tag will point to"
required: true
env:
TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
permissions: {}
jobs:
update_tag:
name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
runs-on: ubuntu-latest
permissions:
contents: write
environment:
name: releaseNewActionVersion
steps:
- name: Update the ${{ env.TAG_NAME }} tag
uses: actions/publish-action@23f4c6f12633a2da8f44938b71fde9afec138fb4 # v0.4.0
with:
source-tag: ${{ env.TAG_NAME }}

View File

@ -7,10 +7,11 @@ on:
- edited - edited
- synchronize - synchronize
permissions: permissions: {}
contents: write
pull-requests: write
jobs: jobs:
main: main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@0.16.0 uses: hoverkraft-tech/ci-github-common/.github/workflows/semantic-pull-request.yml@b17226e57c8ef31f860719766656ebb6df017218 # 0.31.6
permissions:
contents: write
pull-requests: write

View File

@ -4,10 +4,11 @@ on:
schedule: schedule:
- cron: "30 1 * * *" - cron: "30 1 * * *"
permissions: permissions: {}
issues: write
pull-requests: write
jobs: jobs:
main: main:
uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@0.16.0 uses: hoverkraft-tech/ci-github-common/.github/workflows/stale.yml@b17226e57c8ef31f860719766656ebb6df017218 # 0.31.6
permissions:
issues: write
pull-requests: write

1
.gitignore vendored
View File

@ -12,6 +12,7 @@ lerna-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html) # Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
eslint-report.json
# Runtime data # Runtime data
pids pids

View File

@ -1 +1 @@
20.9.0 20.19.3

80
AGENTS.md Normal file
View File

@ -0,0 +1,80 @@
# AGENTS.md — agent instructions and operational contract
This file exists so automated contributors (Copilot agents, bots, scripts) follow the same guardrails as human maintainers when working in `hoverkraft-tech/compose-action`. It summarizes what to read, which commands to run, and what is out of scope for agents.
## Organization-wide guidelines
- Always read and obey [hoverkraft-tech/.github/AGENTS.md](https://github.com/hoverkraft-tech/.github/blob/main/AGENTS.md) before touching this repository.
- Apply any additional instructions surfaced by the workspace (global Visual Studio Code prompts, repo-specific notices) alongside this contract.
## Canonical docs
- [README.md](./README.md) — product overview, supported inputs, and workflow examples. This is the primary contract for action users.
- [CONTRIBUTING.md](./CONTRIBUTING.md) — PR expectations, release hygiene, and how to collaborate with maintainers.
- [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) — behavioral expectations for every interaction.
## Instructional docs
- Source of truth for runtime logic lives under [`src/`](./src). Tests mirror the same structure under [`src/**/*.test.ts`](./src).
- GitHub Action fixtures and sample compose files live under [`test/`](./test). Use them when reproducing CI flows locally.
- Build artifacts belong in `dist/`. Never edit generated files by hand; instead update the matching TypeScript source and rerun the packaging commands described below.
## High-level rules (mandatory)
- Favor small, reviewable diffs. Coordinate large refactors with maintainers before starting.
- Keep behavior changes documented: update `README.md` and any affected workflow snippets.
- Never hardcode secrets, tokens, or personal data. Use GitHub Actions secrets or ask maintainers to provision them.
- Node 20+ is required. Match the tooling versions declared in `package.json`.
## Agent operational contract (when modifying code)
Before opening a PR or pushing a branch:
1. Read the relevant sections of `README.md` and inspect any affected files in `src/` and `test/`.
2. Implement changes in TypeScript source only; regenerate bundles with `npm run package` when shipping executable artifacts.
3. Run local validation limited to impacted areas at minimum:
- `npm run lint` (or `npm run lint:ci` when you need JSON output for CI).
- `npm run build` (type-check only).
- `npm run test` for quick feedback; `npm run test:ci` to reproduce CI (coverage + serial runs).
4. For action behavior changes, exercise the representative workflow under `test/` (e.g., `test/docker-compose.yml`) to confirm compose invocations behave as expected.
5. Add or update unit tests alongside any new logic, covering at least the happy path plus one failure or edge scenario.
6. Keep commits self-contained and use conventional commit messages compatible with `@commitlint/config-conventional`.
When opening a PR:
- Target a feature branch off `main`.
- Describe intent, touched areas, and the manual + automated test plan.
- Reference the docs you followed (for example: "Validated against readme > Usage" or "Followed CONTRIBUTING.md".).
- Ensure CI (lint, build, tests, package) is green before requesting human review.
## Validation & quality gates
- **Build:** `npm run build` must succeed (TypeScript compile cleanly, no `tsc` errors).
- **Lint:** `npm run lint:ci` must pass with no new warnings. Attach `eslint-report.json` to CI artifacts when relevant.
- **Tests:** `npm run test:ci` must pass and update coverage artifacts (see `coverage/`).
- **Bundle:** `npm run package` must regenerate `dist/` outputs; include updated bundles in the PR if runtime code changed.
## Allowed agent actions (examples)
- Fix documentation, typos, or metadata referenced by the GitHub Marketplace listing.
- Add or update unit tests, mocks, and fixtures in `src/` or `test/`.
- Refactor TypeScript modules in small, behavior-preserving increments (with tests and package outputs refreshed).
- Adjust CI/workflow helpers under `test/` to improve local reproducibility.
## Disallowed actions (must not do)
- Do not commit generated `dist/` artifacts without updating the corresponding TypeScript source and documenting the command used.
- Do not introduce new runtime dependencies without maintainer approval; prefer built-in Node APIs or existing deps.
- Do not modify Dockerfiles or GitHub Actions workflows to add secrets, credentials, or privileged steps.
- Do not land breaking changes to the public action inputs/outputs without updating `README.md` and gaining explicit maintainer sign-off.
## Guidance summary (quick checklist)
1. Read `README.md` + relevant source/test files.
2. Make the minimal change; add tests.
3. Run `npm run lint`, `npm run build`, `npm run test:ci`, and `npm run package`.
4. Open a PR referencing the docs you followed and include the test plan.
## If uncertain
Open an issue or draft PR in this repository describing the scenario, what docs you read, and the question you still have. Ping maintainers instead of guessing. When in doubt about the workflow contract, defer to the `README.md` and organization-wide AGENTS file.

View File

@ -1,11 +1,12 @@
#checkov:skip=CKV_DOCKER_2: required FROM ghcr.io/super-linter/super-linter:slim-v8.0.0
FROM ghcr.io/super-linter/super-linter:slim-v7
HEALTHCHECK --interval=5m --timeout=10s --start-period=30s --retries=3 CMD ["/bin/sh","-c","test -d /github/home"]
ARG UID=1000 ARG UID=1000
ARG GID=1000 ARG GID=1000
RUN chown -R ${UID}:${GID} /github/home
USER ${UID}:${GID} USER ${UID}:${GID}
ENV RUN_LOCAL=true ENV RUN_LOCAL=true
ENV USE_FIND_ALGORITHM=true ENV USE_FIND_ALGORITHM=true
ENV LOG_LEVEL=WARN ENV LOG_LEVEL=WARN
ENV LOG_FILE="../logs" ENV LOG_FILE="/github/home/logs"

View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright Hoverkraft Copyright hoverkraft
Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in this software and associated documentation files (the "Software"), to deal in

View File

@ -8,27 +8,33 @@ lint: ## Execute linting
lint-fix: ## Execute linting and fix lint-fix: ## Execute linting and fix
$(call run_linter, \ $(call run_linter, \
-e FIX_JSON_PRETTIER=true \
-e FIX_JAVASCRIPT_PRETTIER=true \
-e FIX_YAML_PRETTIER=true \ -e FIX_YAML_PRETTIER=true \
-e FIX_MARKDOWN=true \ -e FIX_MARKDOWN=true \
-e FIX_JSON_PRETTIER=true \
-e FIX_MARKDOWN_PRETTIER=true \ -e FIX_MARKDOWN_PRETTIER=true \
-e FIX_NATURAL_LANGUAGE=true) -e FIX_NATURAL_LANGUAGE=true \
)
ci: ## Execute all formats and checks
@npm install
@npm audit fix
@npm run all
$(MAKE) lint-fix
define run_linter define run_linter
DEFAULT_WORKSPACE="$(CURDIR)"; \ DEFAULT_WORKSPACE="$(CURDIR)"; \
LINTER_IMAGE="linter:latest"; \ LINTER_IMAGE="linter:latest"; \
VOLUME="$$DEFAULT_WORKSPACE:$$DEFAULT_WORKSPACE"; \ VOLUME="$$DEFAULT_WORKSPACE:$$DEFAULT_WORKSPACE"; \
docker build --build-arg UID=$(id -u) --build-arg GID=$(id -g) --tag $$LINTER_IMAGE .; \ docker build --build-arg UID=$(shell id -u) --build-arg GID=$(shell id -g) --tag $$LINTER_IMAGE .; \
docker run \ docker run \
-e DEFAULT_WORKSPACE="$$DEFAULT_WORKSPACE" \ -e DEFAULT_WORKSPACE="$$DEFAULT_WORKSPACE" \
-e FILTER_REGEX_INCLUDE="$(filter-out $@,$(MAKECMDGOALS))" \ -e FILTER_REGEX_INCLUDE="$(filter-out $@,$(MAKECMDGOALS))" \
-e IGNORE_GITIGNORED_FILES=true \
-e FILTER_REGEX_EXCLUDE=dist/**/* \ -e FILTER_REGEX_EXCLUDE=dist/**/* \
-e VALIDATE_JSCPD=false \
-e VALIDATE_TYPESCRIPT_STANDARD=false \
-e VALIDATE_TYPESCRIPT_ES=false \ -e VALIDATE_TYPESCRIPT_ES=false \
-e VALIDATE_TYPESCRIPT_PRETTIER=false \ -e VALIDATE_TYPESCRIPT_PRETTIER=false \
-e VALIDATE_JAVASCRIPT_ES=false \ -e VALIDATE_JAVASCRIPT_ES=false \
-e VALIDATE_JAVASCRIPT_STANDARD=false \
$(1) \ $(1) \
-v $$VOLUME \ -v $$VOLUME \
--rm \ --rm \

259
README.md
View File

@ -1,113 +1,126 @@
<!-- markdownlint-disable-next-line first-line-heading --> <!-- header:start -->
<div align="center" width="100%">
<!-- start branding -->
<img src=".github/ghadocs/branding.svg" width="15%" align="center" alt="branding<icon:anchor color:gray-dark>" /> # ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItYW5jaG9yIiBjb2xvcj0iYmx1ZSI+PGNpcmNsZSBjeD0iMTIiIGN5PSI1IiByPSIzIj48L2NpcmNsZT48bGluZSB4MT0iMTIiIHkxPSIyMiIgeDI9IjEyIiB5Mj0iOCI+PC9saW5lPjxwYXRoIGQ9Ik01IDEySDJhMTAgMTAgMCAwIDAgMjAgMGgtMyI+PC9wYXRoPjwvc3ZnPg==) GitHub Action: Docker Compose Action
<!-- end branding -->
<!-- start title -->
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:anchor color:gray-dark>" /> GitHub Action: Docker Compose Action
<!-- end title -->
<!-- start badges -->
<a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fcompose-action%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release/hoverkraft-tech/compose-action?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fcompose-action%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date/hoverkraft-tech/compose-action?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit/hoverkraft-tech/compose-action?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fcompose-action%2Fissues"><img src="https://img.shields.io/github/issues/hoverkraft-tech/compose-action?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads/hoverkraft-tech/compose-action/total?logo=github&style=flat-square" alt="Downloads" />
<!-- end badges -->
<div align="center">
<img src=".github/logo.svg" width="60px" align="center" alt="Docker Compose Action" />
</div> </div>
<!-- start description -->
This action runs your docker-compose file and clean up before action finished ---
<!-- end description --> <!-- header:end -->
<!-- start contents --> <!-- badges:start -->
<!-- end contents -->
## Usage [![Marketplace](https://img.shields.io/badge/Marketplace-docker--compose--action-blue?logo=github-actions)](https://github.com/marketplace/actions/docker-compose-action)
[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/compose-action)](https://github.com/hoverkraft-tech/compose-action/releases)
[![License](https://img.shields.io/github/license/hoverkraft-tech/compose-action)](http://choosealicense.com/licenses/mit/)
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/compose-action?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/compose-action?style=social)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/compose-action/blob/main/CONTRIBUTING.md)
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
<!-- badges:end -->
<!-- overview:start -->
## Overview
This action runs your compose file(s) and clean up before action finished
### Action ### Action
The action will run `docker-compose up` to start the services defined in the given compose file(s). 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. 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. Some extra options can be passed to the `docker compose up` command using the `up-flags` input.
### Post hook ### Post hook
On post hook, the action will run `docker-compose down` to clean up the services. On post hook, the action will run `docker compose down` to clean up the services.
In debug mode, the logs of the running services are printed before the cleanup.
Some extra options can be passed to the `docker-compose down` command using the `down-flags` input. 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.
<!-- start usage --> Some extra options can be passed to the `docker compose down` command using the `down-flags` input.
<!-- overview:end -->
<!-- usage:start -->
## Usage
```yaml ```yaml
- uses: hoverkraft-tech/compose-action@v0.0.0 - uses: hoverkraft-tech/compose-action@248470ecc5ed40d8ed3d4480d8260d77179ef579 # v2.4.2
with: with:
# Description: Path to compose file(s). It can be a list of files. It can be # Additional options to pass to `docker` command.
# absolute or relative to the current working directory (cwd). docker-flags: ""
#
# Default: ./docker-compose.yml
compose-file: ""
# Description: Services to perform docker-compose up. # Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd).
# # Default: `./docker-compose.yml`
compose-file: ./docker-compose.yml
# Services to perform `docker compose up`.
services: "" services: ""
# Description: Additional options to pass to `docker-compose up` command. # Additional options to pass to `docker compose up` command.
#
# Default:
up-flags: "" up-flags: ""
# Description: Additional options to pass to `docker-compose down` command. # Additional options to pass to `docker compose down` command.
#
# Default:
down-flags: "" down-flags: ""
# Description: Additional options to pass to `docker-compose` command. # Additional options to pass to `docker compose` command.
#
# Default:
compose-flags: "" compose-flags: ""
# Description: Current working directory # Current working directory
# # Default: `${{ github.workspace }}`
# Default: ${{ github.workspace }} cwd: ${{ github.workspace }}
cwd: ""
# Description: Compose version to use. If null (default), it will use the current # Compose version to use.
# installed version. If "latest", it will install the latest version. # If null (default), it will use the current installed version.
# # If "latest", it will install the latest version.
compose-version: "" compose-version: ""
# Description: The GitHub token used to create an authenticated client (to fetch # The log level used for Docker Compose service logs.
# the latest version of docker-compose). # Can be one of "debug", "info".
# #
# Default: ${{ github.token }} # Default: `debug`
github-token: "" services-log-level: debug
# The GitHub token used to create an authenticated client (to fetch the latest version of Docker Compose).
# Default: `${{ github.token }}`
github-token: ${{ github.token }}
``` ```
<!-- end usage --> <!-- usage:end -->
<!-- inputs:start -->
## Inputs ## Inputs
<!-- start inputs --> | **Input** | **Description** | **Required** | **Default** |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------- |
| **`docker-flags`** | Additional options to pass to `docker` command. | **false** | - |
| **`compose-file`** | Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd). | **false** | `./docker-compose.yml` |
| **`services`** | Services to perform `docker compose up`. | **false** | - |
| **`up-flags`** | Additional options to pass to `docker compose up` command. | **false** | - |
| **`down-flags`** | Additional options to pass to `docker compose down` command. | **false** | - |
| **`compose-flags`** | Additional options to pass to `docker compose` command. | **false** | - |
| **`cwd`** | Current working directory | **false** | `${{ github.workspace }}` |
| **`compose-version`** | Compose version to use. | **false** | - |
| | If null (default), it will use the current installed version. | | |
| | If "latest", it will install the latest version. | | |
| **`services-log-level`** | The log level used for Docker Compose service logs. | **false** | `debug` |
| | Can be one of "debug", "info". | | |
| **`github-token`** | The GitHub token used to create an authenticated client (to fetch the latest version of Docker Compose). | **false** | `${{ github.token }}` |
| **Input** | **Description** | **Default** | **Required** | <!-- inputs:end -->
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | ------------ |
| <code>compose-file</code> | Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd). | <code>./docker-compose.yml</code> | **false** |
| <code>services</code> | Services to perform docker-compose up. | | **false** |
| <code>up-flags</code> | Additional options to pass to <code>docker-compose up</code> command. | | **false** |
| <code>down-flags</code> | Additional options to pass to <code>docker-compose down</code> command. | | **false** |
| <code>compose-flags</code> | Additional options to pass to <code>docker-compose</code> command. | | **false** |
| <code>cwd</code> | Current working directory | <code>${{ github.workspace }}</code> | **false** |
| <code>compose-version</code> | Compose version to use.<br />If null (default), it will use the current installed version.<br />If "latest", it will install the latest version. | | **false** |
| <code>github-token</code> | The GitHub token used to create an authenticated client (to fetch the latest version of docker-compose). | <code>${{ github.token }}</code> | **false** |
<!-- end inputs --> <!-- secrets:start -->
<!-- start outputs --> <!-- secrets:end -->
<!-- end outputs -->
<!-- outputs:start -->
<!-- outputs:end -->
<!-- examples:start -->
## Examples ## Examples
@ -123,27 +136,24 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4.2.2
- name: Run docker-compose - name: Run docker compose
uses: hoverkraft-tech/compose-action@v2.0.1 uses: hoverkraft-tech/compose-action@248470ecc5ed40d8ed3d4480d8260d77179ef579 # v2.4.2
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
- name: Execute tests in the running services - name: Execute tests in the running services
run: | run: |
docker-compose exec test-app pytest docker compose exec test-app pytest
``` ```
<!-- start [.github/ghadocs/examples/] -->
<!-- end [.github/ghadocs/examples/] -->
### Example Using environment variables ### Example Using environment variables
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4.2.2
- uses: hoverkraft-tech/compose-action@v2.0.1 - uses: hoverkraft-tech/compose-action@248470ecc5ed40d8ed3d4480d8260d77179ef579 # v2.4.2
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
env: env:
@ -152,13 +162,13 @@ steps:
### Example using `services` ### Example using `services`
Perform `docker-compose up` to some given service instead of all of them Perform `docker compose up` to some given service instead of all of them
```yaml ```yaml
steps: steps:
# need checkout before using compose-action # need checkout before using compose-action
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: hoverkraft-tech/compose-action@v2.0.1 - uses: hoverkraft-tech/compose-action@248470ecc5ed40d8ed3d4480d8260d77179ef579 # v2.4.2
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
services: | services: |
@ -168,33 +178,86 @@ steps:
### Example using `up-flags` ### Example using `up-flags`
Specify flags to pass to the `docker-compose up`. Default is none. Can be used Specify flags to pass to the `docker compose up`.
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 Default is none.
[docker-compose up documentation](https://docs.docker.com/compose/reference/up/).
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/).
### Example using `down-flags` ### Example using `down-flags`
Specify flags to pass to the `docker-compose down` command during cleanup. 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 Default is none.
flags can be found in the
[docker-compose down documentation](https://docs.docker.com/compose/reference/down/). Can be used to pass the 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/).
### Example using `compose-flags` ### Example using `compose-flags`
Specify flags to pass to the `docker-compose` command. Default is none. A full Specify flags to pass to the `docker compose` command. Default is none.
list of flags can be found in the
[docker-compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help). 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 ```yaml
steps: steps:
# need checkout before using compose-action # need checkout before using compose-action
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: hoverkraft-tech/compose-action@v2.0.1 - uses: hoverkraft-tech/compose-action@248470ecc5ed40d8ed3d4480d8260d77179ef579 # v2.4.2
with: with:
compose-file: "./docker/docker-compose.yml" compose-file: "./docker/docker-compose.yml"
services: | compose-flags: "--profile profile-1"
helloworld2
helloworld3
``` ```
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@248470ecc5ed40d8ed3d4480d8260d77179ef579 # v2.4.2
with:
compose-file: |
./docker/docker-compose.yml
./docker/docker-compose.ci.yml
```
<!-- examples:end -->
<!-- contributing:start -->
## Contributing
Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/compose-action/blob/main/CONTRIBUTING.md) for more details.
<!-- contributing:end -->
<!-- security:start -->
<!-- security:end -->
<!-- license:start -->
## License
This project is licensed under the MIT License.
SPDX-License-Identifier: MIT
Copyright © 2026 hoverkraft
For more details, see the [license](http://choosealicense.com/licenses/mit/).
<!-- license:end -->
<!-- generated:start -->
---
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
<!-- generated:end -->

View File

@ -1,28 +1,46 @@
# ### 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" name: "Docker Compose Action"
description: "This action runs your docker-compose file and clean up before action finished" description: This action runs your compose file(s) and clean up before action finished
author: "Hoverkraft" author: "hoverkraft"
branding: branding:
icon: anchor icon: anchor
color: gray-dark color: blue
inputs: inputs:
docker-flags:
description: "Additional options to pass to `docker` command."
required: false
compose-file: compose-file:
description: "Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd)." description: "Path to compose file(s). It can be a list of files. It can be absolute or relative to the current working directory (cwd)."
required: false required: false
default: "./docker-compose.yml" default: "./docker-compose.yml"
services: services:
description: "Services to perform docker-compose up." description: "Services to perform `docker compose up`."
required: false required: false
up-flags: up-flags:
description: "Additional options to pass to `docker-compose up` command." description: "Additional options to pass to `docker compose up` command."
required: false required: false
default: "" default: ""
down-flags: down-flags:
description: "Additional options to pass to `docker-compose down` command." description: "Additional options to pass to `docker compose down` command."
required: false required: false
default: "" default: ""
compose-flags: compose-flags:
description: "Additional options to pass to `docker-compose` command." description: "Additional options to pass to `docker compose` command."
required: false required: false
default: "" default: ""
cwd: cwd:
@ -35,8 +53,14 @@ inputs:
If null (default), it will use the current installed version. If null (default), it will use the current installed version.
If "latest", it will install the latest version. If "latest", it will install the latest version.
required: false required: false
services-log-level:
description: |
The log level used for Docker Compose service logs.
Can be one of "debug", "info".
required: false
default: "debug"
github-token: github-token:
description: The GitHub token used to create an authenticated client (to fetch the latest version of docker-compose). description: The GitHub token used to create an authenticated client (to fetch the latest version of Docker Compose).
default: ${{ github.token }} default: ${{ github.token }}
required: false required: false

5598
dist/index.js generated vendored

File diff suppressed because it is too large Load Diff

13
dist/licenses.txt generated vendored
View File

@ -625,19 +625,6 @@ Permission to use, copy, modify, and/or distribute this software for any purpose
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
uuid
MIT
The MIT License (MIT)
Copyright (c) 2010-2020 Robert Kieffer and other contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wrappy wrappy
ISC ISC
The ISC License The ISC License

3500
dist/post.js generated vendored

File diff suppressed because it is too large Load Diff

3
eslint.config.mjs Normal file
View File

@ -0,0 +1,3 @@
import { default as tsDevToolsCore } from "@ts-dev-tools/core/dist/eslint-plugin-ts-dev-tools/index.js";
export default tsDevToolsCore.default;

7913
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -2,9 +2,10 @@
"name": "compose-action", "name": "compose-action",
"description": "Docker Compose Action", "description": "Docker Compose Action",
"version": "0.0.0", "version": "0.0.0",
"author": "", "author": "hoverkraft",
"private": true, "license": "MIT",
"homepage": "https://github.com/hoverkraft-tech/compose-action", "homepage": "https://github.com/hoverkraft-tech/compose-action",
"private": true,
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/hoverkraft-tech/compose-action.git" "url": "git+https://github.com/hoverkraft-tech/compose-action.git"
@ -22,23 +23,36 @@
"engines": { "engines": {
"node": ">=20" "node": ">=20"
}, },
"dependencies": {
"@actions/core": "^2.0.1",
"@actions/github": "^6.0.1",
"@actions/tool-cache": "^2.0.2",
"@octokit/action": "^8.0.4",
"docker-compose": "^1.3.0"
},
"devDependencies": {
"@ts-dev-tools/core": "^1.9.14",
"@vercel/ncc": "^0.38.4",
"eslint-plugin-github": "^6.0.0",
"eslint-plugin-jsonc": "^2.21.0"
},
"scripts": { "scripts": {
"package": "npm run package:index && npm run package:post", "package": "npm run package:index && npm run package:post",
"package:index": "ncc build src/index.ts -o dist --license licenses.txt", "package:index": "ncc build src/index.ts -o dist --license licenses.txt",
"package:post": "ncc build src/post.ts -o dist/post && mv dist/post/index.js dist/post.js && rm -rf dist/post", "package:post": "ncc build src/post.ts -o dist/post && mv dist/post/index.js dist/post.js && rm -rf dist/post",
"package:watch": "npm run package -- --watch", "package:watch": "npm run package -- --watch",
"lint": "eslint \"src/**/*.{ts,tsx}\"", "lint": "eslint \"src/**/*.{ts,tsx}\"",
"all": "npm run format && npm run lint && npm run test && npm run package", "lint:ci": "npm run lint -- --output-file eslint-report.json --format json",
"all": "npm run format && npm run lint:ci && npm run test:ci && npm run package",
"build": "tsc --noEmit", "build": "tsc --noEmit",
"format": "prettier --cache --write '**/*.ts'", "format": "prettier --cache --write .",
"jest": "jest --detectOpenHandles --forceExit", "jest": "jest --detectOpenHandles --forceExit",
"test": "npm run jest --maxWorkers=50%", "test": "npm run jest -- --maxWorkers=50%",
"test:watch": "npm run jest --watch --maxWorkers=25%", "test:watch": "npm run jest --watch -- --maxWorkers=25%",
"test:cov": "npm run test --coverage", "test:cov": "npm run test -- --coverage",
"test:ci": "npm run test:cov --runInBand", "test:ci": "npm run jest -- --coverage --runInBand",
"prepare": "ts-dev-tools install" "prepare": "ts-dev-tools install"
}, },
"license": "MIT",
"jest": { "jest": {
"preset": "ts-jest", "preset": "ts-jest",
"verbose": true, "verbose": true,
@ -71,56 +85,11 @@
"**/src/**/*.[jt]s?(x)" "**/src/**/*.[jt]s?(x)"
] ]
}, },
"dependencies": {
"@actions/core": "^1.10.1",
"@actions/github": "^6.0.0",
"@actions/tool-cache": "^2.0.1",
"@octokit/action": "^7.0.0",
"docker-compose": "^1.1.0"
},
"devDependencies": {
"@ts-dev-tools/core": "^1.6.2",
"@vercel/ncc": "^0.38.1",
"eslint-plugin-github": "^5.0.1",
"eslint-plugin-jsonc": "^2.14.1"
},
"eslintConfig": {
"root": true,
"parser": "@typescript-eslint/parser",
"plugins": [
"@typescript-eslint",
"jest"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:jest/recommended",
"prettier"
],
"env": {
"es2021": true
},
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 12,
"sourceType": "module"
},
"settings": {
"jest": {
"version": "detect"
}
},
"ignorePatterns": [
"dist",
"node_modules"
]
},
"prettier": { "prettier": {
"semi": true, "semi": true,
"printWidth": 100, "printWidth": 100,
"trailingComma": "es5" "trailingComma": "es5",
"plugins": []
}, },
"commitlint": { "commitlint": {
"extends": [ "extends": [
@ -139,6 +108,6 @@
} }
}, },
"tsDevTools": { "tsDevTools": {
"version": "20220617100200-prettier-cache" "version": "20250623095600-remove-prettier-oxc"
} }
} }

View File

@ -1,19 +1,19 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { InputService } from "./services/input.service"; import { InputService } from "./services/input.service";
import { LoggerService } from "./services/logger.service"; import { LoggerService, LogLevel } from "./services/logger.service";
import { DockerComposeInstallerService } from "./services/docker-compose-installer.service"; import { DockerComposeInstallerService } from "./services/docker-compose-installer.service";
import * as indexRunner from "./index-runner"; import * as indexRunner from "./index-runner";
import { DockerComposeService } from "./services/docker-compose.service"; import { DockerComposeService } from "./services/docker-compose.service";
// Mock the external libraries and services used by the action
let infoMock: jest.SpiedFunction<typeof LoggerService.prototype.info>;
let debugMock: jest.SpiedFunction<typeof LoggerService.prototype.debug>;
let setFailedMock: jest.SpiedFunction<typeof core.setFailed>;
let getInputsMock: jest.SpiedFunction<typeof InputService.prototype.getInputs>;
let installMock: jest.SpiedFunction<typeof DockerComposeInstallerService.prototype.install>;
let upMock: jest.SpiedFunction<typeof DockerComposeService.prototype.up>;
describe("run", () => { describe("run", () => {
// Mock the external libraries and services used by the action
let infoMock: jest.SpiedFunction<typeof LoggerService.prototype.info>;
let debugMock: jest.SpiedFunction<typeof LoggerService.prototype.debug>;
let setFailedMock: jest.SpiedFunction<typeof core.setFailed>;
let getInputsMock: jest.SpiedFunction<typeof InputService.prototype.getInputs>;
let installMock: jest.SpiedFunction<typeof DockerComposeInstallerService.prototype.install>;
let upMock: jest.SpiedFunction<typeof DockerComposeService.prototype.up>;
beforeEach(() => { beforeEach(() => {
jest.clearAllMocks(); jest.clearAllMocks();
@ -28,6 +28,7 @@ describe("run", () => {
it("should install docker compose with specified version", async () => { it("should install docker compose with specified version", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
@ -36,6 +37,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: "1.29.2", composeVersion: "1.29.2",
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
installMock.mockResolvedValue("1.29.2"); installMock.mockResolvedValue("1.29.2");
@ -49,7 +51,7 @@ describe("run", () => {
expect(infoMock).toHaveBeenCalledWith("Setting up docker compose version 1.29.2"); expect(infoMock).toHaveBeenCalledWith("Setting up docker compose version 1.29.2");
expect(debugMock).toHaveBeenCalledWith( expect(debugMock).toHaveBeenCalledWith(
'inputs: {"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":"1.29.2","githubToken":null}' 'inputs: {"dockerFlags":[],"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":"1.29.2","githubToken":null,"serviceLogLevel":"debug"}'
); );
expect(installMock).toHaveBeenCalledWith({ expect(installMock).toHaveBeenCalledWith({
@ -59,11 +61,13 @@ describe("run", () => {
}); });
expect(upMock).toHaveBeenCalledWith({ expect(upMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
upFlags: [], upFlags: [],
services: [], services: [],
serviceLogger: debugMock,
}); });
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
@ -72,6 +76,7 @@ describe("run", () => {
it("should bring up docker compose services", async () => { it("should bring up docker compose services", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
@ -80,6 +85,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
@ -87,11 +93,13 @@ describe("run", () => {
// Assert // Assert
expect(upMock).toHaveBeenCalledWith({ expect(upMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
upFlags: [], upFlags: [],
services: ["web"], services: ["web"],
serviceLogger: debugMock,
}); });
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();
}); });
@ -102,6 +110,7 @@ describe("run", () => {
upMock.mockRejectedValue(error); upMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
@ -110,6 +119,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
@ -125,6 +135,7 @@ describe("run", () => {
upMock.mockRejectedValue(error); upMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
@ -133,6 +144,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act

View File

@ -36,11 +36,13 @@ export async function run(): Promise<void> {
loggerService.info("Bringing up docker compose service(s)"); loggerService.info("Bringing up docker compose service(s)");
await dockerComposeService.up({ await dockerComposeService.up({
dockerFlags: inputs.dockerFlags,
composeFiles: inputs.composeFiles, composeFiles: inputs.composeFiles,
composeFlags: inputs.composeFlags, composeFlags: inputs.composeFlags,
cwd: inputs.cwd, cwd: inputs.cwd,
upFlags: inputs.upFlags, upFlags: inputs.upFlags,
services: inputs.services, services: inputs.services,
serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel),
}); });
loggerService.info("docker compose service(s) are up"); loggerService.info("docker compose service(s) are up");
} catch (error) { } catch (error) {

View File

@ -1,7 +1,7 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { DockerComposeService } from "./services/docker-compose.service"; import { DockerComposeService } from "./services/docker-compose.service";
import { InputService } from "./services/input.service"; import { InputService } from "./services/input.service";
import { LoggerService } from "./services/logger.service"; import { LoggerService, LogLevel } from "./services/logger.service";
import { DockerComposeInstallerService } from "./services/docker-compose-installer.service"; import { DockerComposeInstallerService } from "./services/docker-compose-installer.service";
let setFailedMock: jest.SpiedFunction<typeof core.setFailed>; let setFailedMock: jest.SpiedFunction<typeof core.setFailed>;
@ -25,6 +25,7 @@ describe("index", () => {
it("calls run when imported", async () => { it("calls run when imported", async () => {
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
@ -33,6 +34,7 @@ describe("index", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
installMock.mockResolvedValue("1.2.3"); installMock.mockResolvedValue("1.2.3");
@ -48,17 +50,19 @@ describe("index", () => {
// Verify that all of the functions were called correctly // Verify that all of the functions were called correctly
expect(debugMock).toHaveBeenNthCalledWith( expect(debugMock).toHaveBeenNthCalledWith(
1, 1,
'inputs: {"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":null,"githubToken":null}' 'inputs: {"dockerFlags":[],"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir","composeVersion":null,"githubToken":null,"serviceLogLevel":"debug"}'
); );
expect(infoMock).toHaveBeenNthCalledWith(3, "Bringing up docker compose service(s)"); expect(infoMock).toHaveBeenNthCalledWith(3, "Bringing up docker compose service(s)");
expect(upMock).toHaveBeenCalledWith({ expect(upMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: debugMock,
}); });
expect(setFailedMock).not.toHaveBeenCalled(); expect(setFailedMock).not.toHaveBeenCalled();

View File

@ -3,5 +3,4 @@
*/ */
import { run } from "./index-runner"; import { run } from "./index-runner";
// eslint-disable-next-line @typescript-eslint/no-floating-promises
run(); run();

View File

@ -1,6 +1,6 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { InputService } from "./services/input.service"; import { InputService } from "./services/input.service";
import { LoggerService } from "./services/logger.service"; import { LoggerService, LogLevel } from "./services/logger.service";
import * as postRunner from "./post-runner"; import * as postRunner from "./post-runner";
import { DockerComposeService } from "./services/docker-compose.service"; import { DockerComposeService } from "./services/docker-compose.service";
@ -27,6 +27,7 @@ describe("run", () => {
it("should bring down docker compose service(s) and log output", async () => { it("should bring down docker compose service(s) and log output", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
@ -35,6 +36,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
logsMock.mockResolvedValue({ error: "", output: "test logs" }); logsMock.mockResolvedValue({ error: "", output: "test logs" });
@ -46,17 +48,21 @@ describe("run", () => {
// Assert // Assert
expect(logsMock).toHaveBeenCalledWith({ expect(logsMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
services: [], services: [],
serviceLogger: debugMock,
}); });
expect(downMock).toHaveBeenCalledWith({ expect(downMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
downFlags: [], downFlags: [],
serviceLogger: debugMock,
}); });
expect(debugMock).toHaveBeenCalledWith("docker compose logs:\ntest logs"); expect(debugMock).toHaveBeenCalledWith("docker compose logs:\ntest logs");
@ -69,6 +75,7 @@ describe("run", () => {
it("should log docker composer errors if any", async () => { it("should log docker composer errors if any", async () => {
// Arrange // Arrange
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
@ -77,6 +84,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
logsMock.mockResolvedValue({ logsMock.mockResolvedValue({
@ -94,14 +102,18 @@ describe("run", () => {
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
dockerFlags: [],
services: [], services: [],
serviceLogger: debugMock,
}); });
expect(downMock).toHaveBeenCalledWith({ expect(downMock).toHaveBeenCalledWith({
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
dockerFlags: [],
downFlags: [], downFlags: [],
serviceLogger: debugMock,
}); });
expect(debugMock).toHaveBeenCalledWith("docker compose error:\ntest logs error"); expect(debugMock).toHaveBeenCalledWith("docker compose error:\ntest logs error");
@ -129,6 +141,7 @@ describe("run", () => {
downMock.mockRejectedValue(error); downMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
@ -137,6 +150,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act
@ -152,6 +166,7 @@ describe("run", () => {
downMock.mockRejectedValue(error); downMock.mockRejectedValue(error);
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["web"], services: ["web"],
composeFlags: [], composeFlags: [],
@ -160,6 +175,7 @@ describe("run", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
// Act // Act

View File

@ -16,10 +16,12 @@ export async function run(): Promise<void> {
const inputs = inputService.getInputs(); const inputs = inputService.getInputs();
const { error, output } = await dockerComposeService.logs({ const { error, output } = await dockerComposeService.logs({
dockerFlags: inputs.dockerFlags,
composeFiles: inputs.composeFiles, composeFiles: inputs.composeFiles,
composeFlags: inputs.composeFlags, composeFlags: inputs.composeFlags,
cwd: inputs.cwd, cwd: inputs.cwd,
services: inputs.services, services: inputs.services,
serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel),
}); });
if (error) { if (error) {
@ -29,10 +31,12 @@ export async function run(): Promise<void> {
loggerService.debug("docker compose logs:\n" + output); loggerService.debug("docker compose logs:\n" + output);
await dockerComposeService.down({ await dockerComposeService.down({
dockerFlags: inputs.dockerFlags,
composeFiles: inputs.composeFiles, composeFiles: inputs.composeFiles,
composeFlags: inputs.composeFlags, composeFlags: inputs.composeFlags,
cwd: inputs.cwd, cwd: inputs.cwd,
downFlags: inputs.downFlags, downFlags: inputs.downFlags,
serviceLogger: loggerService.getServiceLogger(inputs.serviceLogLevel),
}); });
loggerService.info("docker compose is down"); loggerService.info("docker compose is down");

View File

@ -1,7 +1,7 @@
import * as core from "@actions/core"; import * as core from "@actions/core";
import { DockerComposeService } from "./services/docker-compose.service"; import { DockerComposeService } from "./services/docker-compose.service";
import { InputService } from "./services/input.service"; import { InputService } from "./services/input.service";
import { LoggerService } from "./services/logger.service"; import { LoggerService, LogLevel } from "./services/logger.service";
let setFailedMock: jest.SpiedFunction<typeof core.setFailed>; let setFailedMock: jest.SpiedFunction<typeof core.setFailed>;
let getInputsMock: jest.SpiedFunction<typeof InputService.prototype.getInputs>; let getInputsMock: jest.SpiedFunction<typeof InputService.prototype.getInputs>;
@ -24,6 +24,7 @@ describe("post", () => {
it("calls run when imported", async () => { it("calls run when imported", async () => {
getInputsMock.mockImplementation(() => ({ getInputsMock.mockImplementation(() => ({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
@ -32,6 +33,7 @@ describe("post", () => {
cwd: "/current/working/dir", cwd: "/current/working/dir",
composeVersion: null, composeVersion: null,
githubToken: null, githubToken: null,
serviceLogLevel: LogLevel.Debug,
})); }));
logsMock.mockResolvedValue({ error: "", output: "test logs" }); logsMock.mockResolvedValue({ error: "", output: "test logs" });
@ -42,17 +44,21 @@ describe("post", () => {
await new Promise((resolve) => setTimeout(resolve, 0)); await new Promise((resolve) => setTimeout(resolve, 0));
expect(logsMock).toHaveBeenCalledWith({ expect(logsMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
services: [], services: [],
serviceLogger: debugMock,
}); });
expect(downMock).toHaveBeenCalledWith({ expect(downMock).toHaveBeenCalledWith({
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
downFlags: [], downFlags: [],
serviceLogger: debugMock,
}); });
expect(debugMock).toHaveBeenNthCalledWith(1, "docker compose logs:\ntest logs"); expect(debugMock).toHaveBeenNthCalledWith(1, "docker compose logs:\ntest logs");

View File

@ -3,5 +3,4 @@
*/ */
import { run } from "./post-runner"; import { run } from "./post-runner";
// eslint-disable-next-line @typescript-eslint/no-floating-promises
run(); run();

View File

@ -25,11 +25,13 @@ describe("DockerComposeService", () => {
describe("up", () => { describe("up", () => {
it("should call up with correct options", async () => { it("should call up with correct options", async () => {
const upInputs: UpInputs = { const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: [], services: [],
composeFlags: [], composeFlags: [],
upFlags: [], upFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: jest.fn(),
}; };
await service.up(upInputs); await service.up(upInputs);
@ -38,18 +40,62 @@ describe("DockerComposeService", () => {
composeOptions: [], composeOptions: [],
commandOptions: [], commandOptions: [],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
log: true, executable: {
executablePath: "docker",
options: [],
},
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function),
});
// Ensure callback is calling the service logger
const callback = upAllMock?.mock?.calls[0][0]?.callback;
expect(callback).toBeDefined();
const message = "test log output";
if (callback) {
callback(Buffer.from(message));
}
expect(upInputs.serviceLogger).toHaveBeenCalledWith("test log output");
});
it("should call up with specific docker flags", async () => {
const upInputs: UpInputs = {
dockerFlags: ["--context", "dev"],
composeFiles: ["docker-compose.yml"],
services: [],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
await service.up(upInputs);
expect(upAllMock).toHaveBeenCalledWith({
composeOptions: [],
commandOptions: [],
config: ["docker-compose.yml"],
executable: {
executablePath: "docker",
options: ["--context", "dev"],
},
cwd: "/current/working/dir",
callback: expect.any(Function),
}); });
}); });
it("should call up with specific services", async () => { it("should call up with specific services", async () => {
const upInputs: UpInputs = { const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["helloworld2", "helloworld3"], services: ["helloworld2", "helloworld3"],
composeFlags: [], composeFlags: [],
upFlags: ["--build"], upFlags: ["--build"],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: jest.fn(),
}; };
await service.up(upInputs); await service.up(upInputs);
@ -58,19 +104,149 @@ describe("DockerComposeService", () => {
composeOptions: [], composeOptions: [],
commandOptions: ["--build"], commandOptions: ["--build"],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
log: true,
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function),
executable: {
executablePath: "docker",
options: [],
},
}); });
}); });
it("should throw formatted error when upAll fails with docker-compose result", async () => {
const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"],
services: [],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const dockerComposeError = {
exitCode: 1,
err: "Error: unable to pull image\nfailed to resolve reference",
out: "",
};
upAllMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1"
);
await expect(service.up(upInputs)).rejects.toThrow("unable to pull image");
});
it("should throw formatted error when upMany fails with docker-compose result", async () => {
const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"],
services: ["web"],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const dockerComposeError = {
exitCode: 1,
err: "Service 'web' failed to start",
out: "Starting web...",
};
upManyMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1"
);
await expect(service.up(upInputs)).rejects.toThrow("Service 'web' failed to start");
await expect(service.up(upInputs)).rejects.toThrow("Starting web...");
});
it("should pass through docker-compose result without exit code", async () => {
const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"],
services: [],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const dockerComposeError = {
exitCode: null,
err: "Some error without exit code",
out: "",
};
upAllMock.mockRejectedValue(dockerComposeError);
await expect(service.up(upInputs)).rejects.toThrow("Some error without exit code");
});
it("should pass through standard Error objects", async () => {
const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"],
services: [],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const standardError = new Error("Standard error message");
upAllMock.mockRejectedValue(standardError);
await expect(service.up(upInputs)).rejects.toThrow("Standard error message");
});
it("should pass through error strings", async () => {
const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"],
services: [],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const unknownError = "Some unknown error";
upAllMock.mockRejectedValue(unknownError);
await expect(service.up(upInputs)).rejects.toThrow("Some unknown error");
});
it("should handle unknown error types gracefully", async () => {
const upInputs: UpInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"],
services: [],
composeFlags: [],
upFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const unknownError = { unexpected: "error format" };
upAllMock.mockRejectedValue(unknownError);
await expect(service.up(upInputs)).rejects.toThrow(JSON.stringify(unknownError));
});
}); });
describe("down", () => { describe("down", () => {
it("should call down with correct options", async () => { it("should call down with correct options", async () => {
const downInputs: DownInputs = { const downInputs: DownInputs = {
dockerFlags: [],
composeFiles: [], composeFiles: [],
composeFlags: [], composeFlags: [],
downFlags: ["--volumes", "--remove-orphans"], downFlags: ["--volumes", "--remove-orphans"],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: jest.fn(),
}; };
await service.down(downInputs); await service.down(downInputs);
@ -79,19 +255,50 @@ describe("DockerComposeService", () => {
composeOptions: [], composeOptions: [],
commandOptions: ["--volumes", "--remove-orphans"], commandOptions: ["--volumes", "--remove-orphans"],
config: [], config: [],
log: true, executable: {
executablePath: "docker",
options: [],
},
cwd: "/current/working/dir", cwd: "/current/working/dir",
callback: expect.any(Function),
}); });
}); });
it("should throw formatted error when down fails with docker-compose result", async () => {
const downInputs: DownInputs = {
dockerFlags: [],
composeFiles: [],
composeFlags: [],
downFlags: [],
cwd: "/current/working/dir",
serviceLogger: jest.fn(),
};
const dockerComposeError = {
exitCode: 1,
err: "Error stopping containers",
out: "",
};
downMock.mockRejectedValue(dockerComposeError);
await expect(service.down(downInputs)).rejects.toThrow(
"Docker Compose command failed with exit code 1"
);
await expect(service.down(downInputs)).rejects.toThrow("Error stopping containers");
});
}); });
describe("logs", () => { describe("logs", () => {
it("should call logs with correct options", async () => { it("should call logs with correct options", async () => {
const debugMock = jest.fn();
const logsInputs: LogsInputs = { const logsInputs: LogsInputs = {
dockerFlags: [],
composeFiles: ["docker-compose.yml"], composeFiles: ["docker-compose.yml"],
services: ["helloworld2", "helloworld3"], services: ["helloworld2", "helloworld3"],
composeFlags: [], composeFlags: [],
cwd: "/current/working/dir", cwd: "/current/working/dir",
serviceLogger: debugMock,
}; };
logsMock.mockResolvedValue({ exitCode: 0, err: "", out: "logs" }); logsMock.mockResolvedValue({ exitCode: 0, err: "", out: "logs" });
@ -101,9 +308,13 @@ describe("DockerComposeService", () => {
expect(dockerCompose.logs).toHaveBeenCalledWith(["helloworld2", "helloworld3"], { expect(dockerCompose.logs).toHaveBeenCalledWith(["helloworld2", "helloworld3"], {
composeOptions: [], composeOptions: [],
config: ["docker-compose.yml"], config: ["docker-compose.yml"],
log: true,
cwd: "/current/working/dir", cwd: "/current/working/dir",
executable: {
executablePath: "docker",
options: [],
},
follow: false, follow: false,
callback: expect.any(Function),
}); });
}); });
}); });

View File

@ -2,6 +2,7 @@ import {
down, down,
IDockerComposeLogOptions, IDockerComposeLogOptions,
IDockerComposeOptions, IDockerComposeOptions,
IDockerComposeResult,
logs, logs,
upAll, upAll,
upMany, upMany,
@ -9,9 +10,11 @@ import {
import { Inputs } from "./input.service"; import { Inputs } from "./input.service";
type OptionsInputs = { type OptionsInputs = {
dockerFlags: Inputs["dockerFlags"];
composeFiles: Inputs["composeFiles"]; composeFiles: Inputs["composeFiles"];
composeFlags: Inputs["composeFlags"]; composeFlags: Inputs["composeFlags"];
cwd: Inputs["cwd"]; cwd: Inputs["cwd"];
serviceLogger: (message: string) => void;
}; };
export type UpInputs = OptionsInputs & { upFlags: Inputs["upFlags"]; services: Inputs["services"] }; export type UpInputs = OptionsInputs & { upFlags: Inputs["upFlags"]; services: Inputs["services"] };
@ -25,12 +28,16 @@ export class DockerComposeService {
commandOptions: upFlags, commandOptions: upFlags,
}; };
if (services.length > 0) { try {
await upMany(services, options); if (services.length > 0) {
return; await upMany(services, options);
} return;
}
await upAll(options); await upAll(options);
} catch (error) {
throw this.formatDockerComposeError(error);
}
} }
async down({ downFlags, ...optionsInputs }: DownInputs): Promise<void> { async down({ downFlags, ...optionsInputs }: DownInputs): Promise<void> {
@ -39,7 +46,11 @@ export class DockerComposeService {
commandOptions: downFlags, commandOptions: downFlags,
}; };
await down(options); try {
await down(options);
} catch (error) {
throw this.formatDockerComposeError(error);
}
} }
async logs({ services, ...optionsInputs }: LogsInputs): Promise<{ async logs({ services, ...optionsInputs }: LogsInputs): Promise<{
@ -60,15 +71,78 @@ export class DockerComposeService {
} }
private getCommonOptions({ private getCommonOptions({
dockerFlags,
composeFiles, composeFiles,
composeFlags, composeFlags,
cwd, cwd,
serviceLogger,
}: OptionsInputs): IDockerComposeOptions { }: OptionsInputs): IDockerComposeOptions {
return { return {
config: composeFiles, config: composeFiles,
log: true,
composeOptions: composeFlags, composeOptions: composeFlags,
cwd: cwd, cwd: cwd,
callback: (chunk) => serviceLogger(chunk.toString()),
executable: {
executablePath: "docker",
options: dockerFlags,
},
}; };
} }
/**
* Formats docker-compose errors into proper Error objects with readable messages
*/
private formatDockerComposeError(error: unknown): Error {
// If it's already an Error, return it
if (error instanceof Error) {
return error;
}
// Handle docker-compose result objects
if (this.isDockerComposeResult(error)) {
const parts: string[] = [];
// Add exit code information
if (error.exitCode !== null) {
parts.push(`Docker Compose command failed with exit code ${error.exitCode}`);
} else {
parts.push("Docker Compose command failed");
}
// Add error stream output if available
if (error.err && error.err.trim()) {
parts.push("\nError output:");
parts.push(error.err.trim());
}
// Add standard output if available and different from error output
if (error.out && error.out.trim() && error.out !== error.err) {
parts.push("\nStandard output:");
parts.push(error.out.trim());
}
return new Error(parts.join("\n"));
}
// Handle string errors
if (typeof error === "string") {
return new Error(error);
}
// Fallback for unknown error types
return new Error(JSON.stringify(error));
}
/**
* Type guard to check if an object is a docker-compose result
*/
private isDockerComposeResult(error: unknown): error is IDockerComposeResult {
return (
typeof error === "object" &&
error !== null &&
"exitCode" in error &&
"err" in error &&
"out" in error
);
}
} }

View File

@ -1,14 +1,7 @@
import { InputService, InputNames } from "./input.service";
import * as core from "@actions/core"; import * as core from "@actions/core";
import * as fs from "fs"; import fs from "fs";
import { InputService, InputNames } from "./input.service";
jest.mock("fs", () => ({ import { LogLevel } from "./logger.service";
existsSync: jest.fn(),
promises: {
access: jest.fn(),
},
}));
jest.mock("@actions/core");
describe("InputService", () => { describe("InputService", () => {
let service: InputService; let service: InputService;
@ -17,11 +10,22 @@ describe("InputService", () => {
let existsSyncMock: jest.SpiedFunction<typeof fs.existsSync>; let existsSyncMock: jest.SpiedFunction<typeof fs.existsSync>;
beforeEach(() => { beforeEach(() => {
service = new InputService(); jest.clearAllMocks();
existsSyncMock = jest.spyOn(fs, "existsSync").mockImplementation(); existsSyncMock = jest.spyOn(fs, "existsSync").mockImplementation();
getInputMock = jest.spyOn(core, "getInput").mockImplementation(); getInputMock = jest.spyOn(core, "getInput").mockImplementation();
getMultilineInputMock = jest.spyOn(core, "getMultilineInput").mockImplementation(); getMultilineInputMock = jest.spyOn(core, "getMultilineInput").mockImplementation();
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
service = new InputService();
}); });
afterEach(() => { afterEach(() => {
@ -29,6 +33,35 @@ describe("InputService", () => {
}); });
describe("getInputs", () => { describe("getInputs", () => {
describe("docker-flags", () => {
it("should return given docker-flags input", () => {
getInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.DockerFlags:
return "docker-flag1 docker-flag2";
default:
return "";
}
});
existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs();
expect(inputs.dockerFlags).toEqual(["docker-flag1", "docker-flag2"]);
});
it("should return empty array when no docker-flags input", () => {
getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs();
expect(inputs.dockerFlags).toEqual([]);
});
});
describe("composeFiles", () => { describe("composeFiles", () => {
it("should return given composeFiles input", () => { it("should return given composeFiles input", () => {
getMultilineInputMock.mockImplementation((inputName) => { getMultilineInputMock.mockImplementation((inputName) => {
@ -108,15 +141,6 @@ describe("InputService", () => {
describe("compose-flags", () => { describe("compose-flags", () => {
it("should return given compose-flags input", () => { it("should return given compose-flags input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeFlags: case InputNames.ComposeFlags:
@ -134,15 +158,6 @@ describe("InputService", () => {
}); });
it("should return empty array when no compose-flags input", () => { it("should return empty array when no compose-flags input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
@ -155,15 +170,6 @@ describe("InputService", () => {
describe("up-flags", () => { describe("up-flags", () => {
it("should return given up-flags input", () => { it("should return given up-flags input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.UpFlags: case InputNames.UpFlags:
@ -181,15 +187,6 @@ describe("InputService", () => {
}); });
it("should return empty array when no up-flags input", () => { it("should return empty array when no up-flags input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
@ -202,15 +199,6 @@ describe("InputService", () => {
describe("down-flags", () => { describe("down-flags", () => {
it("should return given down-flags input", () => { it("should return given down-flags input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.DownFlags: case InputNames.DownFlags:
@ -228,15 +216,6 @@ describe("InputService", () => {
}); });
it("should return empty array when no down-flags input", () => { it("should return empty array when no down-flags input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockReturnValue(""); getInputMock.mockReturnValue("");
existsSyncMock.mockReturnValue(true); existsSyncMock.mockReturnValue(true);
@ -248,14 +227,6 @@ describe("InputService", () => {
describe("cwd", () => { describe("cwd", () => {
it("should return given cwd input", () => { it("should return given cwd input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.Cwd: case InputNames.Cwd:
@ -274,14 +245,6 @@ describe("InputService", () => {
describe("compose-version", () => { describe("compose-version", () => {
it("should return given compose-version input", () => { it("should return given compose-version input", () => {
getMultilineInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ComposeFile:
return ["file1"];
default:
return [];
}
});
getInputMock.mockImplementation((inputName) => { getInputMock.mockImplementation((inputName) => {
switch (inputName) { switch (inputName) {
case InputNames.ComposeVersion: case InputNames.ComposeVersion:
@ -297,5 +260,53 @@ describe("InputService", () => {
expect(inputs.composeVersion).toEqual("compose-version"); expect(inputs.composeVersion).toEqual("compose-version");
}); });
}); });
describe("services-log-level", () => {
it("should return given services-log-level input", () => {
getInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ServiceLogLevel:
return "info";
default:
return "";
}
});
existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs();
expect(inputs.serviceLogLevel).toEqual(LogLevel.Info);
});
it("should return default services-log-level input", () => {
getInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ServiceLogLevel:
return "";
default:
return "";
}
});
existsSyncMock.mockReturnValue(true);
const inputs = service.getInputs();
expect(inputs.serviceLogLevel).toEqual(LogLevel.Debug);
});
it("should throw an error when services-log-level input is invalid", () => {
getInputMock.mockImplementation((inputName) => {
switch (inputName) {
case InputNames.ServiceLogLevel:
return "invalid-log-level";
default:
return "";
}
});
existsSyncMock.mockReturnValue(true);
expect(() => service.getInputs()).toThrow(
'Invalid service log level "invalid-log-level". Valid values are: debug, info'
);
});
});
}); });
}); });

View File

@ -1,8 +1,10 @@
import { getInput, getMultilineInput } from "@actions/core"; import { getInput, getMultilineInput } from "@actions/core";
import { existsSync } from "fs"; import { existsSync } from "fs";
import { join } from "path"; import { join } from "path";
import { LogLevel } from "./logger.service";
export type Inputs = { export type Inputs = {
dockerFlags: string[];
composeFiles: string[]; composeFiles: string[];
services: string[]; services: string[];
composeFlags: string[]; composeFlags: string[];
@ -11,9 +13,11 @@ export type Inputs = {
cwd: string; cwd: string;
composeVersion: string | null; composeVersion: string | null;
githubToken: string | null; githubToken: string | null;
serviceLogLevel: LogLevel;
}; };
export enum InputNames { export enum InputNames {
DockerFlags = "docker-flags",
ComposeFile = "compose-file", ComposeFile = "compose-file",
Services = "services", Services = "services",
ComposeFlags = "compose-flags", ComposeFlags = "compose-flags",
@ -22,6 +26,7 @@ export enum InputNames {
Cwd = "cwd", Cwd = "cwd",
ComposeVersion = "compose-version", ComposeVersion = "compose-version",
GithubToken = "github-token", GithubToken = "github-token",
ServiceLogLevel = "services-log-level",
} }
export const COMPOSE_VERSION_LATEST = "latest"; export const COMPOSE_VERSION_LATEST = "latest";
@ -29,6 +34,7 @@ export const COMPOSE_VERSION_LATEST = "latest";
export class InputService { export class InputService {
getInputs(): Inputs { getInputs(): Inputs {
return { return {
dockerFlags: this.getDockerFlags(),
composeFiles: this.getComposeFiles(), composeFiles: this.getComposeFiles(),
services: this.getServices(), services: this.getServices(),
composeFlags: this.getComposeFlags(), composeFlags: this.getComposeFlags(),
@ -37,9 +43,14 @@ export class InputService {
cwd: this.getCwd(), cwd: this.getCwd(),
composeVersion: this.getComposeVersion(), composeVersion: this.getComposeVersion(),
githubToken: this.getGithubToken(), githubToken: this.getGithubToken(),
serviceLogLevel: this.getServiceLogLevel(),
}; };
} }
private getDockerFlags(): string[] {
return this.parseFlags(getInput(InputNames.DockerFlags));
}
private getComposeFiles(): string[] { private getComposeFiles(): string[] {
const cwd = this.getCwd(); const cwd = this.getCwd();
const composeFiles = getMultilineInput(InputNames.ComposeFile).filter((composeFile: string) => { const composeFiles = getMultilineInput(InputNames.ComposeFile).filter((composeFile: string) => {
@ -108,4 +119,14 @@ export class InputService {
}) || null }) || null
); );
} }
private getServiceLogLevel(): LogLevel {
const configuredLevel = getInput(InputNames.ServiceLogLevel, { required: false });
if (configuredLevel && !Object.values(LogLevel).includes(configuredLevel as LogLevel)) {
throw new Error(
`Invalid service log level "${configuredLevel}". Valid values are: ${Object.values(LogLevel).join(", ")}`
);
}
return (configuredLevel as LogLevel) || LogLevel.Debug;
}
} }

View File

@ -1,4 +1,4 @@
import { LoggerService } from "./logger.service"; import { LoggerService, LogLevel } from "./logger.service";
import { debug, info, warning } from "@actions/core"; import { debug, info, warning } from "@actions/core";
jest.mock("@actions/core", () => ({ jest.mock("@actions/core", () => ({
@ -43,4 +43,21 @@ describe("LoggerService", () => {
expect(debug).toHaveBeenCalledWith(message); expect(debug).toHaveBeenCalledWith(message);
}); });
}); });
describe("getServiceLogger", () => {
it("should return the correct logger function for debug level", () => {
const logger = loggerService.getServiceLogger(LogLevel.Debug);
expect(logger).toBe(loggerService.debug);
});
it("should return the correct logger function for info level", () => {
const logger = loggerService.getServiceLogger(LogLevel.Info);
expect(logger).toBe(loggerService.info);
});
it("should default to info level if an unknown level is provided", () => {
const logger = loggerService.getServiceLogger("unknown" as LogLevel);
expect(logger).toBe(loggerService.info);
});
});
}); });

View File

@ -12,4 +12,20 @@ export class LoggerService {
debug(message: string) { debug(message: string) {
debug(message); debug(message);
} }
getServiceLogger(level: LogLevel): (message: string) => void {
switch (level) {
case LogLevel.Debug:
return this.debug;
case LogLevel.Info:
return this.info;
default:
return this.info;
}
}
}
export enum LogLevel {
Debug = "debug",
Info = "info",
} }