docker/login-action
1
0
Fork 0
mirror of https://github.com/docker/login-action.git synced 2025-05-11 16:09:29 +02:00
Code Activity

Initial version

Browse source
This commit is contained in:
CrazyMax 2020-08-15 14:45:36 +02:00
commit a0182c1603
No known key found for this signature in database
GPG key ID: 3248E46B6BB8C7F7
20 changed files with 2499 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

60
README.md Normal file
View file

@ -0,0 +1,60 @@
[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-docker-login.svg?style=flat-square)](https://github.com/crazy-max/ghaction-docker-login/releases/latest)
[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--login-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-login)
[![CI workflow](https://img.shields.io/github/workflow/status/crazy-max/ghaction-docker-login/ci?label=ci&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-docker-login/actions?workflow=ci)
[![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/crazy-max)
[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](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).