osiris/.github/workflows/ci.yml at 7555ca495340efd3ea22d3afd4e634c9f7e54ba1 · OsirisRTOS/osiris · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
on:
  push:
    branches:
      - 'main'
  pull_request:
  merge_group:
  workflow_dispatch:

name: Osiris CI

env:
  CARGO_TERM_COLOR: always
  TERM: xterm-256color


jobs:
  container:
    name: Build Container
    runs-on: ubuntu-latest
    permissions:
      packages: write
    outputs:
      container_name: ${{ steps.set_output.outputs.container_name }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Log in to GitHub Container Registry
        uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Set container name as output
        id: set_output
        run: |
          REPO=$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')
          CONTAINER_NAME="ghcr.io/${REPO}/devcontainer:latest"
          echo "container_name=$CONTAINER_NAME" >> $GITHUB_OUTPUT
          echo "container_without_tag=ghcr.io/${REPO}/devcontainer" >> $GITHUB_OUTPUT

      - name: Build and push Docker image
        uses: docker/build-push-action@v2
        with:
          context: .
          file: .devcontainer/Dockerfile
          push: ${{ github.ref == 'refs/heads/main' }}
          tags: ${{ steps.set_output.outputs.container_name }}
          cache-from: type=registry,ref=${{ steps.set_output.outputs.container_name }}-cache
          cache-to: type=registry,ref=${{ steps.set_output.outputs.container_name }}-cache,mode=max

  checks:
    name: ${{ matrix.task }} (${{ matrix.preset }})
    runs-on: ubuntu-latest
    needs: [container]
    strategy:
      fail-fast: false
      matrix:
        preset:
          - stm32l4r5zi
        task:
          - build
          - test
          - verify
          - docs
        include:
          - preset: stm32l4r5zi
            config:
              name: stm32l4r5zi_def
              target: thumbv7em-none-eabi
    container:
      image: ${{ needs.container.outputs.container_name }}
    permissions:
      contents: read
      packages: read
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Load config
        run: just config load ${{ matrix.config.name }} --no-confirm

      - name: Run task
        run: just ${{ matrix.task }}

      - name: Upload docs artifact
        if: matrix.task == 'docs'
        uses: actions/upload-artifact@v4
        with:
          name: docs-${{ matrix.preset }}
          path: target/${{ matrix.config.target }}/doc


  examples:
    name: example ${{ matrix.example }} (${{ matrix.preset }})
    runs-on: ubuntu-latest
    needs: [container]
    strategy:
      fail-fast: false
      matrix:
        preset:
          - stm32l4r5zi
        example:
          - hello-world
          - gpio-button
          - blinkyworld
        include:
          - preset: stm32l4r5zi
            config:
              name: stm32l4r5zi_def
              target: thumbv7em-none-eabi
    container:
      image: ${{ needs.container.outputs.container_name }}
    permissions:
      contents: read
      packages: read
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Load config
        run: just config load ${{ matrix.config.name }} --no-confirm

      - name: Build example
        run: just example ${{ matrix.example }}


  fmt:
    name: Check formatting
    runs-on: ubuntu-latest
    needs: [container]
    container:
      image: ${{ needs.container.outputs.container_name }}
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Check formatting for all Cargo manifests
        run: just fmt --check

  deploy-docs:
    name: Deploy the documentation online
    runs-on: ubuntu-latest
    needs: [checks]
    if: github.ref == 'refs/heads/main'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      contents: read
      pages: write
      id-token: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          sparse-checkout: website

      - name: Download docs
        uses: actions/download-artifact@v4
        with:
          pattern: docs-*
          path: website/docs
          merge-multiple: false

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'website'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4