dagger-for-github/README.md
Gerhard Lazu 75549c92b9
Pin dagger CLI to v0.2 (#81)
Since we published https://github.com/dagger/dagger/releases/tag/v0.3.6
(Nov. 30, 2022), this action started downloading that version (i.e.
`latest`), which resulted in breakage, as described in the issue that
this fixes.

As soon as all tests pass and this gets the OK + merge, we should:
1. Cut a new release for this action (I am thinking v3.2.0)
2. Update the v3 tag to point to this new version

That should fix this for all existing GitHub Actions users without any
intervention on their part.

Fixes https://github.com/dagger/dagger-for-github/issues/80

Signed-off-by: Gerhard Lazu <gerhard@dagger.io>
2022-12-06 19:39:50 +00:00

3 KiB

Dagger

GitHub release GitHub marketplace Test workflow Codecov

About

GitHub Action for Dagger, a programmable deployment system.

Screenshot


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@v3
        with:
          cmds: do test

Install Only

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

Multiple commands

steps:
  -
    name: Dagger
    uses: dagger/dagger-for-github@v3
    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 Dagger version (e.g., 0.2.36, 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.