https://github.com/kengotoda/actions-setup-docker-compose

the GitHub Action setting up docker-compose command
https://github.com/kengotoda/actions-setup-docker-compose

docker docker-compose github-actions

Last synced: about 19 hours ago
JSON representation

the GitHub Action setting up docker-compose command

• Host: GitHub
• URL: https://github.com/kengotoda/actions-setup-docker-compose
• Owner: KengoTODA
• License: mit
• Created: 2020-08-27T03:53:12.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T20:03:53.000Z (23 days ago)
• Last Synced: 2024-10-25T00:45:22.876Z (22 days ago)
• Topics: docker, docker-compose, github-actions
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/setup-docker-compose
• Size: 5.35 MB
• Stars: 23
• Watchers: 4
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub action to setup `docker-compose` command



This action downloads the `docker-compose` command and add it to the `PATH` for following executions. It supports the Linux environment only.

> [!IMPORTANT]

> The `docker-compose` command is now deprecated, consider to use the `docker compose` sub command instead. Refer to [Docker official blog](https://www.docker.com/blog/announcing-compose-v2-general-availability/) for detail.

## How to use

Add a step to your workflow like below:

```yml

  steps:

  - uses: KengoTODA/actions-setup-docker-compose@v1

    with:

      version: '2.14.2' # the full version of `docker-compose` command

```

Or set a `GITHUB_TOKEN` environment variable, to use the latest released version:

```yml

  steps:

  - uses: KengoTODA/actions-setup-docker-compose@main

    env:

      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

The 'latest release' here means [the most recent non-prerelease, non-draft release, sorted by the created_at attribute](https://octokit.github.io/rest.js/v19#repos-get-latest-release).

Note that the `GITHUB_TOKEN` should have [`contents: read` permission](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#contents) to fetch data from the GitHub.com.