Skip to content

Expose GitHub summary unconditionally #821

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 16, 2025
Merged

Expose GitHub summary unconditionally #821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d29d06
Expose report unconditionally
jprinet Apr 1, 2025
f62bf34
Align comments
jprinet Apr 10, 2025
1674631
CR follow-up: inline RECEIPT_FILE path instead of copy
jprinet Apr 16, 2025
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
21 changes: 15 additions & 6 deletions .github/actions/gradle/experiment-1/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ runs:
# Navigate into the folder containing the validation scripts
cd develocity-gradle-build-validation

# Do not exit on error to allow post-actions
set +e

# Run the experiment
./01-validate-incremental-building.sh \
${ARG_GIT_REPO:+"-r" "$ARG_GIT_REPO"} \
Expand All @@ -110,25 +113,31 @@ runs:
${ARG_DEVELOCITY_URL:+"-s" "$ARG_DEVELOCITY_URL"} \
${ARG_DEVELOCITY_ENABLE:+"-e"} \
${RUNNER_DEBUG:+"--debug"}
EXPERIMENT_EXIT_CODE=$?

# Set the Build Scan urls as outputs
RECEIPT_FILE=".data/01-validate-incremental-building/latest/exp1-*.receipt"
BUILD_SCAN_1=$(grep -m 1 "first build" ${RECEIPT_FILE} | sed 's/.* //')
Copy link
Member

Choose a reason for hiding this comment

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

Isn't RECEIPT_FILE undefined now?

Copy link
Member Author

Choose a reason for hiding this comment

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

damned, I missed this one, good catch. I'll fix it in another PR

Copy link
Member

Choose a reason for hiding this comment

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

You could just move the capturing of build scan links to the Fill GitHub summary step inside of the if condition such that the final thing done in this step is the script invocation. That would also allow you to remove the set +e and capturing of the exit code.

Copy link
Member Author

Choose a reason for hiding this comment

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

That makes sense and will put altogether the GitHub I/O in the same step 👍

BUILD_SCAN_2=$(grep -m 1 "second build" ${RECEIPT_FILE} | sed 's/.* //')

echo "buildScanFirstBuild=$BUILD_SCAN_1" >> $GITHUB_OUTPUT
echo "buildScanSecondBuild=$BUILD_SCAN_2" >> $GITHUB_OUTPUT

cat $RECEIPT_FILE >> $GITHUB_STEP_SUMMARY
exit $EXPERIMENT_EXIT_CODE
shell: bash
- name: Archive receipt
id: upload-artifact
uses: actions/upload-artifact@v4
if: always()
with:
name: experiment-1-receipt-${{ github.job }}${{ strategy.job-total > 1 && format('-{0}', strategy.job-index) || '' }}
path: develocity-gradle-build-validation/.data/01-validate-incremental-building/latest*/exp1-*.receipt
- name: Add artifact link to summary
path: develocity-gradle-build-validation/.data/01-validate-incremental-building/latest/exp1-*.receipt
- name: Fill GitHub summary
if: always()
run: |
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
RECEIPT_FILE="develocity-gradle-build-validation/.data/01-validate-incremental-building/latest/exp1-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cat ${RECEIPT_FILE} >> $GITHUB_STEP_SUMMARY
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
fi
shell: bash
21 changes: 15 additions & 6 deletions .github/actions/gradle/experiment-2/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ runs:
# Navigate into the folder containing the validation scripts
cd develocity-gradle-build-validation

# Do not exit on error to allow post-actions
set +e

# Run the experiment
./02-validate-local-build-caching-same-location.sh \
${ARG_GIT_REPO:+"-r" "$ARG_GIT_REPO"} \
Expand All @@ -118,25 +121,31 @@ runs:
${ARG_DEVELOCITY_ENABLE:+"-e"} \
${ARG_FAIL_IF_NOT_FULLY_CACHEABLE:+"-f"} \
${RUNNER_DEBUG:+"--debug"}
EXPERIMENT_EXIT_CODE=$?

# Set the Build Scan urls as outputs
RECEIPT_FILE=".data/02-validate-local-build-caching-same-location/latest/exp2-*.receipt"
BUILD_SCAN_1=$(grep -m 1 "first build" ${RECEIPT_FILE} | sed 's/.* //')
BUILD_SCAN_2=$(grep -m 1 "second build" ${RECEIPT_FILE} | sed 's/.* //')

echo "buildScanFirstBuild=$BUILD_SCAN_1" >> $GITHUB_OUTPUT
echo "buildScanSecondBuild=$BUILD_SCAN_2" >> $GITHUB_OUTPUT

cat $RECEIPT_FILE >> $GITHUB_STEP_SUMMARY
exit $EXPERIMENT_EXIT_CODE
shell: bash
- name: Archive receipt
id: upload-artifact
uses: actions/upload-artifact@v4
if: always()
with:
name: experiment-2-receipt-${{ github.job }}${{ strategy.job-total > 1 && format('-{0}', strategy.job-index) || '' }}
path: develocity-gradle-build-validation/.data/02-validate-local-build-caching-same-location/latest*/exp2-*.receipt
- name: Add artifact link to summary
path: develocity-gradle-build-validation/.data/02-validate-local-build-caching-same-location/latest/exp2-*.receipt
- name: Fill GitHub summary
if: always()
run: |
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
RECEIPT_FILE="develocity-gradle-build-validation/.data/02-validate-local-build-caching-same-location/latest/exp2-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cat ${RECEIPT_FILE} >> $GITHUB_STEP_SUMMARY
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
fi
shell: bash
21 changes: 15 additions & 6 deletions .github/actions/gradle/experiment-3/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ runs:
# Navigate into the folder containing the validation scripts
cd develocity-gradle-build-validation

# Do not exit on error to allow post-actions
set +e

# Run the experiment
./03-validate-local-build-caching-different-locations.sh \
${ARG_GIT_REPO:+"-r" "$ARG_GIT_REPO"} \
Expand All @@ -118,25 +121,31 @@ runs:
${ARG_DEVELOCITY_ENABLE:+"-e"} \
${ARG_FAIL_IF_NOT_FULLY_CACHEABLE:+"-f"} \
${RUNNER_DEBUG:+"--debug"}
EXPERIMENT_EXIT_CODE=$?

# Set the Build Scan urls as outputs
RECEIPT_FILE=".data/03-validate-local-build-caching-different-locations/latest/exp3-*.receipt"
BUILD_SCAN_1=$(grep -m 1 "first build" ${RECEIPT_FILE} | sed 's/.* //')
BUILD_SCAN_2=$(grep -m 1 "second build" ${RECEIPT_FILE} | sed 's/.* //')

echo "buildScanFirstBuild=$BUILD_SCAN_1" >> $GITHUB_OUTPUT
echo "buildScanSecondBuild=$BUILD_SCAN_2" >> $GITHUB_OUTPUT

cat $RECEIPT_FILE >> $GITHUB_STEP_SUMMARY
exit $EXPERIMENT_EXIT_CODE
shell: bash
- name: Archive receipt
id: upload-artifact
uses: actions/upload-artifact@v4
if: always()
with:
name: experiment-3-receipt-${{ github.job }}${{ strategy.job-total > 1 && format('-{0}', strategy.job-index) || '' }}
path: develocity-gradle-build-validation/.data/03-validate-local-build-caching-different-locations/latest*/exp3-*.receipt
- name: Add artifact link to summary
path: develocity-gradle-build-validation/.data/03-validate-local-build-caching-different-locations/latest/exp3-*.receipt
- name: Fill GitHub summary
if: always()
run: |
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
RECEIPT_FILE="develocity-gradle-build-validation/.data/03-validate-local-build-caching-different-locations/latest/exp3-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cat ${RECEIPT_FILE} >> $GITHUB_STEP_SUMMARY
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
fi
shell: bash
21 changes: 15 additions & 6 deletions .github/actions/maven/experiment-1/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ runs:
# Navigate into the folder containing the validation scripts
cd develocity-maven-build-validation

# Do not exit on error to allow post-actions
set +e

# Run the experiment
./01-validate-local-build-caching-same-location.sh \
${ARG_GIT_REPO:+"-r" "$ARG_GIT_REPO"} \
Expand All @@ -118,25 +121,31 @@ runs:
${ARG_DEVELOCITY_ENABLE:+"-e"} \
${ARG_FAIL_IF_NOT_FULLY_CACHEABLE:+"-f"} \
${RUNNER_DEBUG:+"--debug"}
EXPERIMENT_EXIT_CODE=$?

# Set the Build Scan urls as outputs
RECEIPT_FILE=".data/01-validate-local-build-caching-same-location/latest/exp1-*.receipt"
BUILD_SCAN_1=$(grep -m 1 "first build" ${RECEIPT_FILE} | sed 's/.* //')
BUILD_SCAN_2=$(grep -m 1 "second build" ${RECEIPT_FILE} | sed 's/.* //')

echo "buildScanFirstBuild=$BUILD_SCAN_1" >> $GITHUB_OUTPUT
echo "buildScanSecondBuild=$BUILD_SCAN_2" >> $GITHUB_OUTPUT

cat $RECEIPT_FILE >> $GITHUB_STEP_SUMMARY
exit $EXPERIMENT_EXIT_CODE
shell: bash
- name: Archive receipt
id: upload-artifact
uses: actions/upload-artifact@v4
if: always()
with:
name: experiment-1-receipt-${{ github.job }}${{ strategy.job-total > 1 && format('-{0}', strategy.job-index) || '' }}
path: develocity-maven-build-validation/.data/01-validate-local-build-caching-same-location/latest*/exp1-*.receipt
- name: Add artifact link to summary
path: develocity-maven-build-validation/.data/01-validate-local-build-caching-same-location/latest/exp1-*.receipt
- name: Fill GitHub summary
if: always()
run: |
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
RECEIPT_FILE="develocity-maven-build-validation/.data/01-validate-local-build-caching-same-location/latest/exp1-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cat ${RECEIPT_FILE} >> $GITHUB_STEP_SUMMARY
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
fi
shell: bash
21 changes: 15 additions & 6 deletions .github/actions/maven/experiment-2/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ runs:
# Navigate into the folder containing the validation scripts
cd develocity-maven-build-validation

# Do not exit on error to allow post-actions
set +e

# Run the experiment
./02-validate-local-build-caching-different-locations.sh \
${ARG_GIT_REPO:+"-r" "$ARG_GIT_REPO"} \
Expand All @@ -118,25 +121,31 @@ runs:
${ARG_DEVELOCITY_ENABLE:+"-e"} \
${ARG_FAIL_IF_NOT_FULLY_CACHEABLE:+"-f"} \
${RUNNER_DEBUG:+"--debug"}
EXPERIMENT_EXIT_CODE=$?

# Set the Build Scan urls as outputs
RECEIPT_FILE=".data/02-validate-local-build-caching-different-locations/latest/exp2-*.receipt"
BUILD_SCAN_1=$(grep -m 1 "first build" ${RECEIPT_FILE} | sed 's/.* //')
BUILD_SCAN_2=$(grep -m 1 "second build" ${RECEIPT_FILE} | sed 's/.* //')

echo "buildScanFirstBuild=$BUILD_SCAN_1" >> $GITHUB_OUTPUT
echo "buildScanSecondBuild=$BUILD_SCAN_2" >> $GITHUB_OUTPUT

cat $RECEIPT_FILE >> $GITHUB_STEP_SUMMARY
exit $EXPERIMENT_EXIT_CODE
shell: bash
- name: Archive receipt
id: upload-artifact
uses: actions/upload-artifact@v4
if: always()
with:
name: experiment-2-receipt-${{ github.job }}${{ strategy.job-total > 1 && format('-{0}', strategy.job-index) || '' }}
path: develocity-maven-build-validation/.data/02-validate-local-build-caching-different-locations/latest*/exp2-*.receipt
- name: Add artifact link to summary
path: develocity-maven-build-validation/.data/02-validate-local-build-caching-different-locations/latest/exp2-*.receipt
- name: Fill GitHub summary
if: always()
run: |
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
RECEIPT_FILE="develocity-maven-build-validation/.data/02-validate-local-build-caching-different-locations/latest/exp2-*.receipt"
if [ -f ${RECEIPT_FILE} ]; then
cat ${RECEIPT_FILE} >> $GITHUB_STEP_SUMMARY
echo "-------------" >> $GITHUB_STEP_SUMMARY
echo "Download receipt: ${{ steps.upload-artifact.outputs.artifact-url }}" >> $GITHUB_STEP_SUMMARY
fi
shell: bash