|
| 1 | +name: CRD Size Badge |
| 2 | + |
| 3 | +on: |
| 4 | + push: |
| 5 | + branches: |
| 6 | + - main |
| 7 | + - '[0-9]+.[0-9]+-fr[0-9]+' |
| 8 | + pull_request_target: |
| 9 | + branches: |
| 10 | + - main |
| 11 | + - '[0-9]+.[0-9]+-fr[0-9]+' |
| 12 | + |
| 13 | +permissions: |
| 14 | + pull-requests: write |
| 15 | + |
| 16 | +jobs: |
| 17 | + crd-size: |
| 18 | + runs-on: ubuntu-latest |
| 19 | + steps: |
| 20 | + - name: Checkout |
| 21 | + uses: actions/checkout@v4 |
| 22 | + with: |
| 23 | + ref: ${{ github.event.pull_request.head.sha || github.sha }} |
| 24 | + |
| 25 | + - name: Install yq |
| 26 | + uses: mikefarah/yq@v4 |
| 27 | + |
| 28 | + - name: Compute CRD JSON size |
| 29 | + id: size |
| 30 | + run: | |
| 31 | + CRD_FILE="config/crd/bases/core.openstack.org_openstackcontrolplanes.yaml" |
| 32 | + SIZE=$(yq eval -o=json "$CRD_FILE" | jq -c . | wc -c) |
| 33 | + echo "bytes=$SIZE" >> "$GITHUB_OUTPUT" |
| 34 | +
|
| 35 | + if [ "$SIZE" -lt 307200 ]; then |
| 36 | + echo "color=green" >> "$GITHUB_OUTPUT" |
| 37 | + echo "status=comfortable" >> "$GITHUB_OUTPUT" |
| 38 | + elif [ "$SIZE" -lt 409600 ]; then |
| 39 | + echo "color=yellow" >> "$GITHUB_OUTPUT" |
| 40 | + echo "status=growing" >> "$GITHUB_OUTPUT" |
| 41 | + elif [ "$SIZE" -lt 768000 ]; then |
| 42 | + echo "color=orange" >> "$GITHUB_OUTPUT" |
| 43 | + echo "status=concerning" >> "$GITHUB_OUTPUT" |
| 44 | + else |
| 45 | + echo "color=red" >> "$GITHUB_OUTPUT" |
| 46 | + echo "status=approaching etcd limit" >> "$GITHUB_OUTPUT" |
| 47 | + fi |
| 48 | +
|
| 49 | + # Human-readable size |
| 50 | + if [ "$SIZE" -ge 1048576 ]; then |
| 51 | + HUMAN="$(awk "BEGIN {printf \"%.1f\", $SIZE/1048576}")MB" |
| 52 | + else |
| 53 | + HUMAN="$(awk "BEGIN {printf \"%.0f\", $SIZE/1024}")KB" |
| 54 | + fi |
| 55 | + echo "human=$HUMAN" >> "$GITHUB_OUTPUT" |
| 56 | +
|
| 57 | + - name: Compute base branch size |
| 58 | + if: github.event_name == 'pull_request_target' |
| 59 | + id: base_size |
| 60 | + run: | |
| 61 | + CRD_FILE="config/crd/bases/core.openstack.org_openstackcontrolplanes.yaml" |
| 62 | + git fetch origin "${{ github.base_ref }}" --depth=1 |
| 63 | + BASE_SIZE=$(git show "origin/${{ github.base_ref }}:${CRD_FILE}" | yq eval -o=json - | jq -c . | wc -c) |
| 64 | + echo "bytes=$BASE_SIZE" >> "$GITHUB_OUTPUT" |
| 65 | +
|
| 66 | + CHANGE=$(awk "BEGIN {if ($BASE_SIZE == 0) printf \"N/A\"; else printf \"%+.2f\", ((${{ steps.size.outputs.bytes }} - $BASE_SIZE) / $BASE_SIZE) * 100}") |
| 67 | + echo "change=$CHANGE" >> "$GITHUB_OUTPUT" |
| 68 | +
|
| 69 | + - name: Find existing comment |
| 70 | + if: github.event_name == 'pull_request_target' |
| 71 | + uses: peter-evans/find-comment@v3 |
| 72 | + id: find_comment |
| 73 | + with: |
| 74 | + issue-number: ${{ github.event.pull_request.number }} |
| 75 | + comment-author: 'github-actions[bot]' |
| 76 | + body-includes: '<!-- crd-size-badge -->' |
| 77 | + |
| 78 | + - name: Post or update PR comment |
| 79 | + if: github.event_name == 'pull_request_target' |
| 80 | + uses: peter-evans/create-or-update-comment@v4 |
| 81 | + with: |
| 82 | + comment-id: ${{ steps.find_comment.outputs.comment-id }} |
| 83 | + issue-number: ${{ github.event.pull_request.number }} |
| 84 | + edit-mode: replace |
| 85 | + body: | |
| 86 | + <!-- crd-size-badge --> |
| 87 | + ## OpenStackControlPlane CRD Size Report |
| 88 | +
|
| 89 | + | Metric | Value | |
| 90 | + |--------|-------| |
| 91 | + | **CRD JSON size** | ${{ steps.size.outputs.bytes }} bytes (${{ steps.size.outputs.human }}) | |
| 92 | + | **Base branch size** | ${{ steps.base_size.outputs.bytes }} bytes | |
| 93 | + | **Change** | ${{ steps.base_size.outputs.change }}% | |
| 94 | + | **Status** | ${{ steps.size.outputs.color }} — ${{ steps.size.outputs.status }} | |
| 95 | +
|
| 96 | + <details> |
| 97 | + <summary>Threshold reference</summary> |
| 98 | +
|
| 99 | + | Color | Range | Meaning | |
| 100 | + |-------|-------|---------| |
| 101 | + | :green_circle: green | < 300KB | Comfortable | |
| 102 | + | :yellow_circle: yellow | 300–400KB | Growing | |
| 103 | + | :orange_circle: orange | 400–750KB | Concerning | |
| 104 | + | :red_circle: red | > 750KB | Approaching 1.5MB etcd limit (cut in half to allow space for update) | |
| 105 | +
|
| 106 | + </details> |
| 107 | +
|
| 108 | + - name: Update badge gist |
| 109 | + if: github.event_name == 'push' |
| 110 | + uses: schneegans/dynamic-badges-action@v1.7.0 |
| 111 | + with: |
| 112 | + auth: ${{ secrets.GIST_SECRET }} |
| 113 | + gistID: ${{ vars.GIST_ID }} |
| 114 | + filename: crd-size-${{ github.ref_name }}.json |
| 115 | + label: CRD Size |
| 116 | + message: ${{ steps.size.outputs.human }} |
| 117 | + color: ${{ steps.size.outputs.color }} |
0 commit comments