-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add CI/CD workflows for automated build, test, and release proc… #2
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @jsonify, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a robust and automated CI/CD pipeline for the ClickIt macOS application. The primary goal is to standardize the build, test, and release processes, moving away from manual steps towards a more reliable, consistent, and efficient tag-based GitHub Actions workflow. This significantly improves the developer experience and ensures proper application packaging and distribution for macOS.
Highlights
- Automated CI/CD Workflows: Implemented GitHub Actions for automated build, test, and release processes, triggered by version tags, significantly streamlining the release pipeline.
- Standardized Build Configuration: Centralized
Info.plistand build settings using newly addedClickIt/Info.plistandClickIt/ClickIt.xcconfigfiles. This ensures consistent application metadata, critical macOS privacy usage descriptions (e.g., Accessibility, Screen Capture), and entitlements across both Xcode and Swift Package Manager (SPM) builds. - Improved SPM Build Process: Enhanced the
build_app_unified.shscript to correctly bundle the Sparkle framework and setrpathfor SPM-based builds, resolving runtime issues for dependencies and enabling auto-updates. - Comprehensive Documentation: Added a detailed
docs/xcode-workflow-tutorial.mdto guide developers through the new Xcode-centric development and automated release workflow, covering setup, daily development, release procedures, and troubleshooting. - Enhanced Code Signing: Updated the build script to properly sign embedded frameworks before the main app bundle and to utilize entitlements, which is crucial for macOS notarization and security.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces CI/CD workflows and significantly refactors the build and development process to be more automated and robust. The changes include updates to the build scripts, new documentation, and configuration for both SPM and Xcode-based workflows. My review focuses on ensuring consistency, correctness, and security in these new processes.
|
|
||
| ## 📋 Overview | ||
|
|
||
| This tutorial covers the complete workflow for developing and releasing ClickIt using **Xcode as the primary development environment** with **automated GitHub Actions CI/CD** for releases. No more manual build scripts or command-line complexity! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new tutorial establishes an Xcode-centric development workflow (open ClickIt.xcodeproj). However, this directly contradicts the updated CLAUDE.md file, which now promotes a Swift Package Manager-centric workflow (open Package.swift) as the primary method. Maintaining two conflicting "primary" workflow documents will be very confusing.
| MACOSX_DEPLOYMENT_TARGET = 15.0 | ||
|
|
||
| // Swift settings | ||
| SWIFT_VERSION = 5.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| <key>NSSystemAdministrationUsageDescription</key> | ||
| <string>ClickIt requires accessibility access to simulate mouse clicks and detect window information.</string> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| CODESIGN_ARGS="$CODESIGN_ARGS --entitlements \"$ENTITLEMENTS_FILE\"" | ||
| fi | ||
|
|
||
| if eval "codesign $CODESIGN_ARGS \"$APP_BUNDLE\"" 2>/dev/null; then |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using eval with variables can be a security risk if the variables contain unexpected characters or commands. It's best practice to avoid eval when possible.
| if eval "codesign $CODESIGN_ARGS \"$APP_BUNDLE\"" 2>/dev/null; then | |
| codesign_args=(["--deep"] ["--force"] ["--sign"] ["$CERT_NAME"]) | |
| if [ -f "$ENTITLEMENTS_FILE" ]; then | |
| echo "🔐 Using entitlements from $ENTITLEMENTS_FILE" | |
| codesign_args+=(["--entitlements"] ["$ENTITLEMENTS_FILE"]) | |
| fi | |
| if codesign "${codesign_args[@]}" "$APP_BUNDLE" 2>/dev/null; then |
… tools version to 6.0
… setting deployment target
…esses