[GHA] Upload installer README to S3 when modified#4028
Conversation
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4028 +/- ##
=======================================
Coverage 74.58% 74.58%
=======================================
Files 293 293
Lines 10817 10817
Branches 1353 1353
=======================================
Hits 8068 8068
Misses 2354 2354
Partials 395 395
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
b56ad1d to
1b16c76
Compare
1b16c76 to
1bc927d
Compare
imnasnainaec
left a comment
There was a problem hiding this comment.
@imnasnainaec reviewed 2 of 2 files at r2, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @copilot)
There was a problem hiding this comment.
Pull Request Overview
This PR adds automatic S3 upload functionality to the installer workflow to upload the installer README PDF to s3://software.thecombine.app when installer/README.md is modified on push to master. It also includes minor formatting improvements to the README text.
Key Changes
- Added git-based file change detection to identify modifications to
installer/README.md - Integrated conditional AWS credential configuration and S3 upload steps into the existing
make_readmejob - Updated harden-runner allowed endpoints to include S3 and STS services for AWS access
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| .github/workflows/installer.yml | Added file change detection step, AWS credentials configuration, and S3 upload logic with fetch-depth 2 for git diff support; updated harden-runner endpoints |
| installer/README.md | Minor formatting improvements: rewrapped text for the Skype note and added a comma in the "Connecting to The Combine" section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment was marked as resolved.
This comment was marked as resolved.
25ec672 to
1bc927d
Compare
|
an id of changed-readme adds clarity to the later usage. |
imnasnainaec
left a comment
There was a problem hiding this comment.
@imnasnainaec reviewed 1 of 1 files at r5, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @copilot)
jasonleenaylor
left a comment
There was a problem hiding this comment.
@jasonleenaylor reviewed 1 of 2 files at r2, 1 of 1 files at r5, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @copilot)
Upload installer README to AWS S3 when modified
Summary
This PR updates the
.github/workflows/installer.ymlworkflow to automatically uploadinstaller/README.pdftos3://software.thecombine.appwheninstaller/README.mdchanges on push to master.Changes Made
github.event.beforeImplementation Details
The change detection logic handles multiple scenarios:
The upload steps only run when:
Security Summary
No security vulnerabilities detected by CodeQL analysis.
Fixes #4025
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
This change is