Skip to content

Latest commit

 

History

History
116 lines (85 loc) · 3.28 KB

README.md

File metadata and controls

116 lines (85 loc) · 3.28 KB
Raw

Setup Lando

This action installs Lando in GitHub Actions. With it you can:

  • Install using a version-spec-ish eg 3, 3.12, 3.x, 3.14.0
  • Install using convenience aliases eg stable, 4-latest, dev 3-edge
  • Set global Lando config configuration

NOTE: If you are using a self-hosted or custom runner you may need to install the needed Lando dependenices eg Docker and Docker Compose for Lando to work correctly!

Inputs

All inputs are optional. If you do nothing the latest stable Lando will be installed.

Name Description Default Example
lando-version The version of Lando to install. If set this has primacy over lando-version-file. stable 3.14.0
lando-version-file A file that contains the version of Lando to install. .lando-version .tool-versions
config A list of . delimited config. If set these have primacy over values in config-file null engineConfig.port=2376
config-file The path to a Lando global config file to use. null /config/lando-global.yml

Outputs

outputs:
  lando-path:
    description: "The path to the installed version of Lando."
    value: ${{ steps.setup-lando.outputs.lando-path }}

Usage

Basic Usage

- name: Setup Lando
  uses: lando/setup-lando@v2

Advanced Usage

Version examples:

- name: Setup Lando
  uses: lando/setup-lando@v2
  with:
    lando-version: stable | edge | dev | latest | 3 | 3.14.0 | 3.11 | pm-preview | https://url.to.my.lando.cli

Version spec and config file:

- name: Setup Lando
  uses: lando/setup-lando@v2
  with:
    lando-version: ">2"
    config-file: config.yaml

Version file and config list:

- name: Setup Lando
  uses: lando/setup-lando@v2
  with:
    lando-version-file: .tool-versions
    config: |
      core.engine=docker-colima
      core.telemetry=false
      plugins.@lando/php=/home/runner/work/php/php

NOTE: The above config is meant purely for illustration.

Everything, everywhere, all at once:

- name: Setup Lando
  uses: lando/setup-lando@v2
  with:
    architecture: x64
    config: |
      core.engine=docker-colima
      core.telemetry=false
      plugins.@lando/php=/home/runner/work/php/php
    config-file: config.yaml
    debug: true
    dependency-check: error|warn|false
    lando-version: 3.14.0
    lando-version-file: .tool-versions
    os: macOS
    telemetry: false
    token: ${{ github.token }}

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Releasing

Create a release and publish to GitHub Actions Marketplace. Note that the release tag must be a semantic version.

Contributors

Made with contrib.rocks.

Other Resources