docker/setup-docker-action
3
0
Fork 0
mirror of https://github.com/docker/setup-docker-action.git synced 2025-04-21 16:10:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
CrazyMax 2023-03-02 14:17:20 +01:00
parent 28ce5cb2f7
commit c9ff0c831b
No known key found for this signature in database
GPG Key ID: 3248E46B6BB8C7F7
2 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.github/setup-docker-action.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

53
README.md Normal file
View File

@ -0,0 +1,53 @@
[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-setup-docker.svg?style=flat-square)](https://github.com/crazy-max/ghaction-setup-docker/releases/latest)
[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--docker-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-docker)
[![CI workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-setup-docker/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-setup-docker/actions?workflow=ci)
[![Test workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-setup-docker/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-setup-docker/actions?workflow=test)
[![Codecov](https://img.shields.io/codecov/c/github/crazy-max/ghaction-setup-docker?logo=codecov&style=flat-square)](https://codecov.io/gh/crazy-max/ghaction-setup-docker)
## About
GitHub Action to set up [Docker CE](https://docs.docker.com/engine/). Works on
Linux, macOS and Windows.
![Screenshot](.github/setup-docker-action.png)
___
* [Usage](#usage)
* [Customizing](#customizing)
* [inputs](#inputs)
* [Contributing](#contributing)
## Usage
```yaml
name: ci
on:
push:
jobs:
docker:
runs-on: ubuntu-latest
steps:
-
name: Set up Docker
uses: crazy-max/ghaction-setup-docker@v1
with:
version: 23.0.1
```
## Customizing
### inputs
Following inputs can be used as `step.with` keys
| Name | Type | Description |
|-----------|--------|-------------------------------------|
| `version` | String | Docker CE version (e.g., `23.0.1`). |
## Contributing
Want to contribute? Awesome! You can find information about contributing to
this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)