kpenfound / dagger-for-github

GitHub Action for Dagger

About

GitHub Action for Dagger, a programmable deployment system.

---

• Usage
  • Basic
  • Install Only
  • Multiple commands
• Customizing
  • inputs
• License

Usage

Basic

name: dagger

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Dagger
        uses: dagger/dagger-for-github@v4
        with:
          cmds: do test

Install Only

steps:
  -
    name: Install Dagger
    uses: dagger/dagger-for-github@v4
    with:
      install-only: true
  -
    name: Show Dagger version
    run: dagger-cue version

Install Only and --with

steps:
  -
    name: Install Dagger
      uses: dagger/dagger-for-github@v4
      with:
        install-only: true
     
  -
    name: Build a subdir example
    run: |
      dagger-cue do build --log-format plain -with 'actions:build:subdir: ${{env.SUBDIR}}'

Multiple commands

steps:
  -
    name: Dagger
    uses: dagger/dagger-for-github@v4
    with:
      cmds: |
        project update
        do test

Customizing

inputs

Following inputs can be used as step.with keys

List type is a newline-delimited string

cmds: |
  project update
  do test

Name	Type	Default	Description
version	String	0.2.232	Dagger version (e.g., 0.2.232, latest, https://github.com/dagger/dagger.git#main)
cmds	List		List of Dagger commands
workdir	String	.	Working directory (below repository root)
install-only	Bool	false	Just install Dagger
cleanup	Bool	true	Cleanup Dagger home folder at the end of a job

Development

# format code and build javascript artifacts
docker buildx bake pre-checkin

# validate all code has correctly formatted and built
docker buildx bake validate

# run tests
docker buildx bake test

License

Apache-2.0 License. See LICENSE for more details.