Draft
Conversation
- Build and archive the macOS app on macos-15 runners - Support optional code signing via repository secrets - Create GitHub Release with AutoPiP.zip on tag push (v*) - Support manual workflow dispatch for testing - Add build & release documentation to README Agent-Logs-Url: https://github.com/vordenken/AutoPiP/sessions/47b39758-17c2-47bd-bdc1-4212a817ceb9 Co-authored-by: vordenken <62395860+vordenken@users.noreply.github.com>
…flow
- Add semver.txt as single source of truth for versioning
- Push to main → stable release (v{version}), push to develop → beta release (v{version}-beta)
- Auto-set MARKETING_VERSION and CURRENT_PROJECT_VERSION in Xcode project
- Auto-create git tags and GitHub Releases
- Auto-update appcast.xml on main for Sparkle (with beta channel support)
- Optional Sparkle EdDSA signing via SPARKLE_PRIVATE_KEY secret
- Update README with new release workflow documentation
Agent-Logs-Url: https://github.com/vordenken/AutoPiP/sessions/47b39758-17c2-47bd-bdc1-4212a817ceb9
Co-authored-by: vordenken <62395860+vordenken@users.noreply.github.com>
Agent-Logs-Url: https://github.com/vordenken/AutoPiP/sessions/47b39758-17c2-47bd-bdc1-4212a817ceb9 Co-authored-by: vordenken <62395860+vordenken@users.noreply.github.com>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Reviewer's GuideAdds a macOS GitHub Actions workflow that automates versioned builds, GitHub releases, and Sparkle appcast updates driven by a new semver.txt file, and documents the process in the README. Sequence diagram for automated build, release, and appcast updatesequenceDiagram
actor Developer
participant GitHubRepo
participant Workflow as BuildReleaseWorkflow
participant Runner as MacOSRunner
participant Xcode as Xcodebuild
participant GH as GitHubReleases
participant Sparkle as SparkleTools
Developer->>GitHubRepo: Update semver.txt
Developer->>GitHubRepo: Push to main or develop
GitHubRepo-->>Workflow: Trigger on push (semver.txt)
Workflow->>Runner: Start job build-and-release
Runner->>GitHubRepo: Checkout repository
Runner->>Runner: Read semver.txt
Runner->>Runner: Derive tag/channel (stable or beta)
Runner->>GitHubRepo: Check if tag already exists
alt Tag exists
Runner->>Runner: Skip release creation
else New tag
Runner->>Runner: Import signing certificate (if secret present)
Runner->>GitHubRepo: Update MARKETING_VERSION and CURRENT_PROJECT_VERSION
Runner->>Xcode: Resolve packages and archive app
Xcode-->>Runner: AutoPiP.xcarchive
Runner->>Runner: Create AutoPiP.zip
Runner->>GH: Create tag and GitHub Release with AutoPiP.zip
opt SPARKLE_PRIVATE_KEY configured
Runner->>Sparkle: Download Sparkle tools
Runner->>Sparkle: sign_update AutoPiP.zip
Sparkle-->>Runner: EdDSA signature
end
Runner->>GitHubRepo: Update appcast.xml with new item
Runner->>GitHubRepo: Commit and push appcast.xml to main
end
Runner->>Runner: Cleanup temporary keychain
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
README.md (1)
90-90: Consider adding the Sparkle key generation command.The documentation mentions the Sparkle
generate_keystool but doesn't show the command. Adding the actual command would improve usability.📝 Suggested addition
-**Export your Sparkle key:** The EdDSA private key generated by Sparkle's `generate_keys` tool. Store it as the `SPARKLE_PRIVATE_KEY` secret. +**Export your Sparkle key:** + +```bash +# Generate Sparkle keys (if not already generated) +# ./bin/generate_keys +# Then copy the private key for use as the secret +cat ~/sparkle_private_key +``` + +Store the EdDSA private key as the `SPARKLE_PRIVATE_KEY` secret.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 90, Update the README to show the exact Sparkle key generation and retrieval steps: add a short snippet invoking the generate_keys tool (e.g., run the project's generate_keys binary/script), then show the command to output the generated EdDSA private key so users can copy it, and finally instruct to store that private key value as the SPARKLE_PRIVATE_KEY secret; reference the generate_keys tool name and the SPARKLE_PRIVATE_KEY secret in the text so readers can locate the actions..github/workflows/build-release.yml (1)
218-241: Consider adding retry logic for concurrent workflow runs.If two workflows run concurrently (e.g., manual trigger during an automatic run), both may attempt to push to
mainsimultaneously. The second push would fail with a non-fast-forward error. While this is a rare scenario and the workflow would show a clear failure, adding a retry loop withgit pull --rebasewould improve robustness.🔄 Proposed enhancement for concurrent safety
git add appcast.xml if git diff --cached --quiet; then echo "appcast.xml unchanged — nothing to push" else git commit -m "chore: update appcast for ${{ steps.version.outputs.tag }}" - git push origin main + + # Retry push in case of concurrent workflow runs + for i in 1 2 3; do + if git push origin main; then + break + fi + if [ $i -lt 3 ]; then + echo "Push failed, retrying after pull..." + git pull --rebase origin main + else + echo "::error::Failed to push after 3 attempts" + exit 1 + fi + done fi🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/build-release.yml around lines 218 - 241, The "Push appcast to main" step can fail on concurrent pushes; wrap the git push origin main in a short retry loop that on failure runs git pull --rebase (or git fetch && git rebase origin/main), re-applies the staged changes, re-commits if necessary, and retries up to N times with a small sleep; specifically modify the block that does git add appcast.xml / git commit -m "chore: update appcast..." / git push origin main to catch non-fast-forward errors, perform git pull --rebase (or fetch+rebase), and retry the git push a few times before giving up. Ensure the logic preserves the commit message from the existing commit invocation and only retries when git push fails due to remote conflicts.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/build-release.yml:
- Line 194: The DOWNLOAD_URL value currently uses the lowercase repo name
"vordenken/autopip"; update the DOWNLOAD_URL string to use the repository's
correct casing ("vordenken/AutoPiP") so the variable DOWNLOAD_URL =
"https://github.com/vordenken/AutoPiP/releases/download/${TAG}/AutoPiP.zip"
reflects the proper repository name; adjust only the repository segment in the
DOWNLOAD_URL assignment.
- Around line 210-216: After running the awk insertion that writes to
"$RUNNER_TEMP/appcast_new.xml", validate that the insertion actually occurred
(for example by checking that the generated file contains the NEW_ITEM or that
the expected anchor "<title>AutoPiP Updates</title>" was present and the new
item string appears) before moving it over appcast.xml; if the check fails, emit
a clear error message and exit non‑zero so the workflow stops instead of
silently continuing. Target the awk invocation and the subsequent mv/echo steps
(NEW_ITEM, appcast.xml, "$RUNNER_TEMP/appcast_new.xml") and add a conditional
that greps or otherwise verifies the inserted content, failing fast when absent.
---
Nitpick comments:
In @.github/workflows/build-release.yml:
- Around line 218-241: The "Push appcast to main" step can fail on concurrent
pushes; wrap the git push origin main in a short retry loop that on failure runs
git pull --rebase (or git fetch && git rebase origin/main), re-applies the
staged changes, re-commits if necessary, and retries up to N times with a small
sleep; specifically modify the block that does git add appcast.xml / git commit
-m "chore: update appcast..." / git push origin main to catch non-fast-forward
errors, perform git pull --rebase (or fetch+rebase), and retry the git push a
few times before giving up. Ensure the logic preserves the commit message from
the existing commit invocation and only retries when git push fails due to
remote conflicts.
In `@README.md`:
- Line 90: Update the README to show the exact Sparkle key generation and
retrieval steps: add a short snippet invoking the generate_keys tool (e.g., run
the project's generate_keys binary/script), then show the command to output the
generated EdDSA private key so users can copy it, and finally instruct to store
that private key value as the SPARKLE_PRIVATE_KEY secret; reference the
generate_keys tool name and the SPARKLE_PRIVATE_KEY secret in the text so
readers can locate the actions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9d5517c3-68fe-4178-ac22-7e306486cd46
📒 Files selected for processing (3)
.github/workflows/build-release.ymlREADME.mdsemver.txt
.github/workflows/build-release.yml
Outdated
| CHANNEL_EL=$'\n'" <sparkle:channel>beta</sparkle:channel>" | ||
| fi | ||
|
|
||
| DOWNLOAD_URL="https://github.com/vordenken/autopip/releases/download/${TAG}/AutoPiP.zip" |
There was a problem hiding this comment.
Repository name case inconsistency in download URL.
The download URL uses vordenken/autopip (lowercase) while the repository appears to be vordenken/AutoPiP (based on README line 28). GitHub typically redirects lowercase URLs to the proper case, but for consistency and to avoid potential issues, use the correct casing.
🔧 Proposed fix
- DOWNLOAD_URL="https://github.com/vordenken/autopip/releases/download/${TAG}/AutoPiP.zip"
+ DOWNLOAD_URL="https://github.com/vordenken/AutoPiP/releases/download/${TAG}/AutoPiP.zip"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| DOWNLOAD_URL="https://github.com/vordenken/autopip/releases/download/${TAG}/AutoPiP.zip" | |
| DOWNLOAD_URL="https://github.com/vordenken/AutoPiP/releases/download/${TAG}/AutoPiP.zip" |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/workflows/build-release.yml at line 194, The DOWNLOAD_URL value
currently uses the lowercase repo name "vordenken/autopip"; update the
DOWNLOAD_URL string to use the repository's correct casing ("vordenken/AutoPiP")
so the variable DOWNLOAD_URL =
"https://github.com/vordenken/AutoPiP/releases/download/${TAG}/AutoPiP.zip"
reflects the proper repository name; adjust only the repository segment in the
DOWNLOAD_URL assignment.
Comment on lines
+210
to
+216
| # Insert after <title>AutoPiP Updates</title> | ||
| awk -v item="$NEW_ITEM" \ | ||
| '/<title>AutoPiP Updates<\/title>/{print; print item; next} {print}' \ | ||
| appcast.xml > "$RUNNER_TEMP/appcast_new.xml" | ||
|
|
||
| mv "$RUNNER_TEMP/appcast_new.xml" appcast.xml | ||
| echo "appcast.xml updated — $CHANNEL $VERSION" |
There was a problem hiding this comment.
Add validation for appcast insertion success.
The awk command silently fails if the anchor line <title>AutoPiP Updates</title> is missing or malformed in appcast.xml. This would result in the release being created but Sparkle updates not being distributed. Add validation to ensure the new item was actually inserted.
✅ Proposed fix to validate insertion
awk -v item="$NEW_ITEM" \
'/<title>AutoPiP Updates<\/title>/{print; print item; next} {print}' \
appcast.xml > "$RUNNER_TEMP/appcast_new.xml"
+ # Validate that the new version was inserted
+ if ! grep -q "sparkle:version=\"${VERSION}\"" "$RUNNER_TEMP/appcast_new.xml"; then
+ echo "::error::Failed to insert new item into appcast.xml - anchor not found"
+ exit 1
+ fi
+
mv "$RUNNER_TEMP/appcast_new.xml" appcast.xml
echo "appcast.xml updated — $CHANNEL $VERSION"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| # Insert after <title>AutoPiP Updates</title> | |
| awk -v item="$NEW_ITEM" \ | |
| '/<title>AutoPiP Updates<\/title>/{print; print item; next} {print}' \ | |
| appcast.xml > "$RUNNER_TEMP/appcast_new.xml" | |
| mv "$RUNNER_TEMP/appcast_new.xml" appcast.xml | |
| echo "appcast.xml updated — $CHANNEL $VERSION" | |
| # Insert after <title>AutoPiP Updates</title> | |
| awk -v item="$NEW_ITEM" \ | |
| '/<title>AutoPiP Updates<\/title>/{print; print item; next} {print}' \ | |
| appcast.xml > "$RUNNER_TEMP/appcast_new.xml" | |
| # Validate that the new version was inserted | |
| if ! grep -q "sparkle:version=\"${VERSION}\"" "$RUNNER_TEMP/appcast_new.xml"; then | |
| echo "::error::Failed to insert new item into appcast.xml - anchor not found" | |
| exit 1 | |
| fi | |
| mv "$RUNNER_TEMP/appcast_new.xml" appcast.xml | |
| echo "appcast.xml updated — $CHANNEL $VERSION" |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/workflows/build-release.yml around lines 210 - 216, After running
the awk insertion that writes to "$RUNNER_TEMP/appcast_new.xml", validate that
the insertion actually occurred (for example by checking that the generated file
contains the NEW_ITEM or that the expected anchor "<title>AutoPiP
Updates</title>" was present and the new item string appears) before moving it
over appcast.xml; if the check fails, emit a clear error message and exit
non‑zero so the workflow stops instead of silently continuing. Target the awk
invocation and the subsequent mv/echo steps (NEW_ITEM, appcast.xml,
"$RUNNER_TEMP/appcast_new.xml") and add a conditional that greps or otherwise
verifies the inserted content, failing fast when absent.
- Replace zip with create-dmg for .dmg output (matching local workflow) - Move Sparkle signing + appcast update BEFORE GitHub Release - Only the final signed DMG is attached to the release - Update all references from .zip to .dmg - Update README accordingly Agent-Logs-Url: https://github.com/vordenken/AutoPiP/sessions/75397440-3f68-478a-9731-f4c2f9843792 Co-authored-by: vordenken <62395860+vordenken@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
.github/workflows/build-release.yml:create-dmgto produceAutoPiP.dmg.zip→.dmg.dmgREADME.mdto referenceAutoPiP.dmginstead ofAutoPiP.zip