devcontainer-features/.github/workflows/test.yaml at main · csutter/devcontainer-features · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
name: "Test"

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  docs:
    name: "Ensure documentation has been generated"
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6

      - name: "Install devcontainer CLI"
        run: npm install -g @devcontainers/cli

      - name: "Generate docs"
        run: devcontainer features generate-docs -p src -n csutter/devcontainer-features

      - name: "Verify docs are up to date"
        run: git diff --quiet -- */**/README.md

  shellcheck:
    name: Shellcheck
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6

      - name: Run ShellCheck
        uses: ludeeus/action-shellcheck@2.0.0

  validate:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Validate devcontainer-feature.json files
        uses: devcontainers/action@v1
        with:
          validate-only: "true"
          base-path-to-features: ./src

  test:
    name: "Test ${{ matrix.feature }} on ${{ matrix.baseImage }}"
    runs-on: ubuntu-latest
    continue-on-error: true
    strategy:
      matrix:
        feature:
          - personal-setup
        baseImage:
          # Vanilla distribution images
          - docker.io/library/debian:latest
          - docker.io/library/ubuntu:latest
          - quay.io/fedora/fedora-toolbox:latest
          # Microsoft devcontainer base image
          - mcr.microsoft.com/devcontainers/base:ubuntu
    steps:
      - uses: actions/checkout@v4

      # The personal-setup feature requires my dotfiles folders to be present in the expected
      # location, so clone the public repo to simulate this, and fake the private repo mount.
      - name: "Prepare demo dotfiles mounts"
        run: |
          mkdir -p $HOME/src/csutter
          mkdir $HOME/src/csutter/dotfiles-private
          git clone https://github.com/csutter/dotfiles.git $HOME/src/csutter/dotfiles

      - name: "Install devcontainer CLI"
        run: npm install -g @devcontainers/cli

      - name: "Test feature: ${{ matrix.feature }} on ${{ matrix.baseImage }}"
        run: devcontainer features test --features ${{ matrix.feature }} --base-image ${{ matrix.baseImage }}