GenAIExamples/.github/workflows/dockerhub-description.yml at 174ecdea2d8a58696f15e463c4ee1aa27c066f41 · opea-project/GenAIExamples · 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
# Copyright (C) 2025 Intel Corporation
# SPDX-License-Identifier: Apache-2.0

name: Update Docker Hub Description
permissions:
  contents: read
on:
  schedule:
    - cron: "0 0 * * 0"
  workflow_dispatch:

jobs:
  get-images-matrix:
    runs-on: ubuntu-latest
    outputs:
      examples_json: ${{ steps.extract.outputs.examples_json }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Extract images info and generate JSON matrix
        id: extract
        run: |
          #!/bin/bash
          set -e
          images=$(awk -F'|' '/^\| *\[opea\// {
            gsub(/^ +| +$/, "", $2);
            gsub(/^ +| +$/, "", $4);
            gsub(/^ +| +$/, "", $5);

            # Extract the path portion of the dockerHub link from the Example Images column
            match($2, /\(https:\/\/hub\.docker\.com\/r\/[^)]*\)/);
            repository = substr($2, RSTART, RLENGTH);
            # Remove the prefix and the trailing right bracket
            sub(/^\(https:\/\/hub\.docker\.com\/r\//, "", repository);
            sub(/\)$/, "", repository);

            # Description Direct assignment
            description = $4;

            # Extract the content of the github link from the Readme column
            match($5, /\(https:\/\/github\.com\/[^)]*\)/);
            readme_url = substr($5, RSTART, RLENGTH);
            # Remove the prefix and the trailing right bracket
            sub(/^\(https:\/\/github\.com\//, "", readme_url);
            sub(/\)$/, "", readme_url);
            # Remove blob information, such as "blob/main/" or "blob/habana_main/"
            gsub(/blob\/[^/]+\//, "", readme_url);
            # Remove the organization name and keep only the file path, such as changing "opea-project/GenAIExamples/AudioQnA/README.md" to "GenAIExamples/AudioQnA/README.md"
            sub(/^[^\/]+\//, "", readme_url);

            # Generate JSON object string
            printf "{\"repository\":\"%s\",\"short-description\":\"%s\",\"readme-filepath\":\"%s\"}\n", repository, description, readme_url;
          }' docker_images_list.md)

          # Concatenate all JSON objects into a JSON array, using paste to separate them with commas
          json="[$(echo "$images" | paste -sd, -)]"
          echo "$json"
          # Set as output variable for subsequent jobs to use
          echo "::set-output name=examples_json::$json"

  check-images-matrix:
    runs-on: ubuntu-latest
    needs: get-images-matrix
    if: ${{ needs.get-images-matrix.outputs.examples_json != '' }}
    strategy:
      matrix:
        image: ${{ fromJSON(needs.get-images-matrix.outputs.examples_json) }}
      fail-fast: false
    steps:
    - name: Check dockerhub description
      run: |
        echo "dockerhub description for ${{ matrix.image.repository }}"
        echo "short-description: ${{ matrix.image.short-description }}"
        echo "readme-filepath: ${{ matrix.image.readme-filepath }}"

  dockerHubDescription:
    runs-on: ubuntu-latest
    needs: get-images-matrix
    if: ${{ needs.get-images-matrix.outputs.examples_json != '' }}
    strategy:
      matrix:
        image: ${{ fromJSON(needs.get-images-matrix.outputs.examples_json) }}
      fail-fast: false
    steps:
    - name: Checkout GenAIExamples
      uses: actions/checkout@v4
      with:
        repository: opea-project/GenAIExamples
        path: GenAIExamples

    - name: Checkout GenAIComps
      uses: actions/checkout@v4
      with:
        repository: opea-project/GenAIComps
        path: GenAIComps

    - name: Checkout vllm-openvino
      uses: actions/checkout@v4
      with:
        repository: vllm-project/vllm
        path: vllm

    - name: Checkout vllm-gaudi
      uses: actions/checkout@v4
      with:
        repository: HabanaAI/vllm-fork
        ref: habana_main
        path: vllm-fork

    - name: add dockerhub description
      uses: peter-evans/dockerhub-description@v4
      with:
        username: ${{ secrets.DOCKERHUB_USER }}
        password: ${{ secrets.DOCKERHUB_TOKEN }}
        repository: ${{ matrix.image.repository }}
        short-description: ${{ matrix.image.short-description }}
        readme-filepath: ${{ matrix.image.readme-filepath }}
        enable-url-completion: false