docker-login/README.md
2020-08-15 14:57:48 +02:00

2.5 KiB

GitHub release GitHub marketplace CI workflow Become a sponsor Paypal Donate

About

GitHub Action to login against a Docker registry

If you are interested, check out my other :octocat: GitHub Actions!

GitHub Pages


Usage

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: crazy-max/ghaction-docker-login@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.