mirror of
https://github.com/docker/login-action.git
synced 2024-11-23 11:19:03 +00:00
61 lines
2.4 KiB
Markdown
61 lines
2.4 KiB
Markdown
|
[](https://github.com/crazy-max/ghaction-docker-login/releases/latest)
|
||
|
|
[](https://github.com/marketplace/actions/docker-login)
|
||
|
|
[](https://github.com/crazy-max/ghaction-docker-login/actions?workflow=ci)
|
||
|
|
[](https://github.com/sponsors/crazy-max)
|
||
|
|
[](https://www.paypal.me/crazyws)
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
GitHub Action to login against a Docker registry
|
||
|
|
|
||
|
|
If you are interested, [check out](https://git.io/Je09Y) my other :octocat: GitHub Actions!
|
||
|
|
|
||
|
|
___
|
||
|
|
|
||
|
|
* [Usage](#usage)
|
||
|
|
* [Customizing](#customizing)
|
||
|
|
* [inputs](#inputs)
|
||
|
|
* [Limitation](#limitation)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
name: ci
|
||
|
|
|
||
|
|
on:
|
||
|
|
push:
|
||
|
|
branches: master
|
||
|
|
tags:
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
login:
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
-
|
||
|
|
name: Checkout
|
||
|
|
uses: actions/checkout@v2
|
||
|
|
-
|
||
|
|
name: Login to DockerHub
|
||
|
|
uses: docker/login-action@v1
|
||
|
|
with:
|
||
|
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||
|
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Customizing
|
||
|
|
|
||
|
|
### inputs
|
||
|
|
|
||
|
|
Following inputs can be used as `step.with` keys
|
||
|
|
|
||
|
|
| Name | Type | Default | Description |
|
||
|
|
|------------------|---------|-----------------------------|------------------------------------|
|
||
|
|
| `registry` | String | | Server address of Docker registry. If not set then will default to Docker Hub |
|
||
|
|
| `username` | String | | Username used to log against the Docker registry |
|
||
|
|
| `password` | String | | Password or personal access token used to log against the Docker registry |
|
||
|
|
| `logout` | Bool | `true` | Log out from the Docker registry at the end of a job |
|
||
|
|
|
||
|
|
## Limitation
|
||
|
|
|
||
|
|
This action is only available for Linux [virtual environments](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources).
|