Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI] Add workflow to guard against increases in the binary size #6529

Merged
merged 17 commits into from
Jan 16, 2025
Merged
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions .github/workflows/ci-check-bundle-size.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Check Binaries bundle size
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved

on:
push:
branches: [main]

pull_request:
branches: [main]

concurrency:
group: ${{ github.workflow }}-${{ (github.event.pull_request && github.event.pull_request.number) || github.ref || github.run_id }}
cancel-in-progress: true

# See https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions
permissions:
contents: read

jobs:
build-and-check:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's move this as yet another job into .github/workflows/ci-lint-checks.yaml so that it runs as part of the overall lint group.

Suggested change
build-and-check:
binary-size-check:

runs-on: ubuntu-latest
steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
submodules: true

- name: Fetch git tags
run: |
git fetch --prune --unshallow --tags
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this necessary? We don't rely on tags in this workflow

Copy link
Contributor Author

@chahatsagarmain chahatsagarmain Jan 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we dont need it , this was used here

- name: Fetch git tags
so i let it be , This can be removed .


- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x

- name: Setup Node.js version
uses: ./.github/actions/setup-node.js

- name: Build jaeger binary
run: make build-jaeger

- name: Calculate bundle size
run: |
TOTAL_SIZE=$(du -sb ./cmd/jaeger/jaeger-linux-amd64 | cut -f1)
echo "$TOTAL_SIZE" > ./new_bundle_size.txt
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved
echo "Total bundle size: $TOTAL_SIZE bytes"

- name: Restore previous bundle size
id: cache-bundle-size
uses: actions/cache/restore@1bd1e32a3bdc45362d1e726936510720a7c30a57 #v4.2.0
with:
path: ./bundle_size.txt
key: jaeger-bundle
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved
restore-keys: |
jaeger-bundle

- name: Compare bundle sizes
if: steps.cache-bundle-size.outputs.cache-hit == 'true'
run: |
OLD_BUNDLE_SIZE=$(cat ./bundle_size.txt)
NEW_BUNDLE_SIZE=$(cat ./new_bundle_size.txt)
echo "Previous bundle size: $OLD_BUNDLE_SIZE bytes"
echo "New bundle size: $NEW_BUNDLE_SIZE bytes"

SIZE_CHANGE=$(( $NEW_BUNDLE_SIZE - $OLD_BUNDLE_SIZE ))
PERCENTAGE_CHANGE=$(( SIZE_CHANGE * 100 / $OLD_BUNDLE_SIZE ))
echo "Size change: $PERCENTAGE_CHANGE%"
if [ $PERCENTAGE_CHANGE -gt 2 ]; then
echo "❌ Bundle size increased by more than 2% ($PERCENTAGE_CHANGE%)"
exit 1
else
echo "✅ Bundle size change is within acceptable range ($PERCENTAGE_CHANGE%)"
fi


- name: Remove previous *_bundle_*.txt
run: |
rm -rf ./bundle_size.txt
mv ./new_bundle_size.txt ./bundle_size.txt

- name: Save new bundle size
if: ${{ (github.event_name == 'push') && (github.ref == 'refs/heads/main') }}
uses: actions/cache/save@1bd1e32a3bdc45362d1e726936510720a7c30a57 #v4.2.0
with:
path: ./bundle_size.txt
key: jaeger-bundle_${{ github.run_id }}
Loading