This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
dagger/.github/workflows/test-docs.yml
Gerhard Lazu 15f156e8c7
Use more descriptive names for GitHub Checks
The existing checks didn't read well in the `gh` cli:

    ❯ gh pr checks
    All checks were successful
    0 failing, 7 successful, 0 skipped, and 0 pending checks

    ✓  DCO                                 https://probot.github.io/apps/dco/
    ✓  Docs                         6m37s  https://github.com/dagger/dagger/runs/5136044870?check_suite_focus=true
    ✓  Everything                   1m43s  https://github.com/dagger/dagger/runs/5136044863?check_suite_focus=true
    ✓  Integration                  4m10s  https://github.com/dagger/dagger/runs/5136044871?check_suite_focus=true
    ✓  Universe                     11m6s  https://github.com/dagger/dagger/runs/5136044860?check_suite_focus=true
    ✓  Universe - Europa            3m18s  https://github.com/dagger/dagger/runs/5136044932?check_suite_focus=true
    ✓  netlify/devel-docs-dagge...         https://app.netlify.com/sites/devel-docs-dagger-io/deploys/620499ee88ee240008b6cabf

This change gives them more descriptive names:

    ❯ gh pr checks
    All checks were successful
    0 failing, 8 successful, 0 skipped, and 0 pending checks

    ✓  DCO                                             https://probot.github.io/apps/dco/
    ✓  Integration Tests                       4m22s   https://github.com/dagger/dagger/runs/5139842686?check_suite_focus=true
    ✓  Lint                                    1m29s   https://github.com/dagger/dagger/runs/5139842774?check_suite_focus=true
    ✓  Test Docs                               7m44s   https://github.com/dagger/dagger/runs/5139842682?check_suite_focus=true
    ✓  Unit Tests                              2m11s   https://github.com/dagger/dagger/runs/5139842684?check_suite_focus=true
    ✓  Universe Tests                          13m14s  https://github.com/dagger/dagger/runs/5139842932?check_suite_focus=true
    ✓  Universe Tests - Europa                 2m36s   https://github.com/dagger/dagger/runs/5139842678?check_suite_focus=true
    ✓  netlify/devel-docs-dagger-io/deploy...          https://deploy-preview-1593--devel-docs-dagger-io.netlify.app

Signed-off-by: Gerhard Lazu <gerhard@lazu.co.uk>
2022-02-10 11:31:21 +00:00

84 lines
2.4 KiB
YAML

name: "Test Docs"
on:
push:
branches: [main]
paths:
- '**.go'
- '**.cue'
- 'docs/**'
- 'Makefile'
- '.github/workflows/test-docs.yml'
pull_request:
branches: [main]
paths:
- '**.go'
- '**.cue'
- 'docs/**'
- 'Makefile'
- '.github/workflows/test-docs.yml'
jobs:
test-docs:
name: "Test Docs"
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- name: "Check out"
uses: actions/checkout@v2
- name: "Setup Go"
uses: actions/setup-go@v1
with:
go-version: 1.16
- name: "Install CUE"
run: |
# Cue
export CUE_VERSION="$(grep cue ./go.mod | cut -d' ' -f2 | head -1 | sed -E 's/\.[[:digit:]]\.[[:alnum:]]+-[[:alnum:]]+$//')"
export CUE_TARBALL="cue_${CUE_VERSION}_linux_amd64.tar.gz"
echo "Installing cue version $CUE_VERSION"
curl -L https://github.com/cue-lang/cue/releases/download/${CUE_VERSION}/${CUE_TARBALL} | sudo tar zxf - -C /usr/local/bin
- name: "Run local registry"
run: |
docker run -d -p 5000:5000 --name registry registry:2
# TODO: DISABLED for CI deadlock debugging
# - name: Generate KiND config
# run: |
# echo 'kind: Cluster
# apiVersion: kind.x-k8s.io/v1alpha4
# containerdConfigPatches:
# - |-
# [plugins."io.containerd.grpc.v1.cri".registry.mirrors."localhost:5000"]
# endpoint = ["http://registry:5000"]' > ./kind-config.yaml
# cat ./kind-config.yaml
# - name: "Setup KiND"
# uses: helm/kind-action@v1.2.0
# with:
# config: "./kind-config.yaml"
# - name: Connect local registry to KiND
# run: |
# docker network connect kind registry
- name: "Import Dagger private key"
env:
DAGGER_AGE_KEY: ${{ secrets.DAGGER_AGE_KEY }}
run: |
mkdir -p ~/.config/dagger
echo "$DAGGER_AGE_KEY" > ~/.config/dagger/keys.txt
- name: "Expose GitHub Runtime"
uses: crazy-max/ghaction-github-runtime@v1
- name: Test
# TODO: https://github.com/dagger/dagger/pull/1341
# env:
# DAGGER_CACHE_TO: "type=gha,mode=max,scope=test-docs"
# DAGGER_CACHE_FROM: "type=gha,mode=max,scope=test-docs"
run: |
make doc-test