Chimera 🐉

A powerful CI tool for Xcode and Swift packages that runs locally in your terminal.

Warning

🐲 Chimera might turn your Macbook into a portable furnace. She's a fire-breathing beast, after all! 🔥 Consider "Macs Fan Control" from crystalidea.com to avoid spontaneous combustion.

Description:

This is a simple CI system using bash scripts to automate building, testing, and cleaning your Xcode projects and Swift packages locally in your terminal. It can also be used to build and test projects in the cloud. With github actions, you can run these scripts on a remote server.

Problem

1. Slow Manual Processes: Manually building, testing, and cleaning Xcode projects and Swift packages is time-consuming.
2. Error-Prone Manual Tasks: Manual processes are susceptible to human errors during building, testing, and cleaning.
3. Build Artifact Clutter: Temporary build files (Package.resolved, .build) accumulate, wasting disk space and potentially causing build issues.

Solution

1. Automated CI with Bash Scripts: Bash scripts are used to automate the build, test, and clean processes for Xcode projects and Swift packages.
2. Specific Task Scripts: Individual scripts are provided for testing Xcode schemes, testing Swift packages, and cleaning build artifacts, allowing for targeted automation.
3. Cleanup Scripts for Fresh Builds: Scripts are included to remove Package.resolved and .build folders, ensuring clean builds, dependency updates, and disk space savings.

Note

Chimera supports both local and remote CI. While cloud-based CI offers scalability, local CI provides faster feedback and closely mirrors your production environment.

Local usage and installation:

1. Just drag and drop the scripts into your Xcode project folder and package folder. See structure below.
2. Drag the run_ci.sh script onto your terminal.app icon and it will run everything automagically ✨
3. If you want to be fancy, you can drag the run_ci_w_spinner.sh script onto your terminal.app icon and it will run everything with a fancy spinner.

File Structure:

Place the scripts like this in your xcode project folder:

.
├── run_ci.sh
├── build_schemes.sh
└── Packages/
    ├── run_all_scripts.sh
    ├── run_swift_builds.sh
    ├── run_swift_tests.sh
    ├── remove_package_resolved.sh
    └── remove_build_folders.sh

Note

Customize your CI! Chimera provides a foundation, but you can tailor it to your project's specific needs. Integrate tools for linting, static analysis, security scanning, and more. Consider adding steps for:

• Code Formatting: Use swiftformat or similar tools to enforce consistent code style.
• Static Analysis: Employ swiftlint or other static analyzers to catch potential bugs and enforce coding standards.
• Security Audits: Integrate tools to scan for security vulnerabilities in your code.
• Dependency Management: Automate dependency updates and vulnerability checks.
• Automated Testing: Expand your test suite to cover more scenarios and edge cases.
• AI-Powered Code Review: Use AI tools to assist with code reviews and identify potential issues.

The possibilities are endless! Adapt Chimera to create a CI pipeline that perfectly fits your workflow.

Scripts

Here's a quick overview of each script:

• run_ci.sh: Runs all CI scripts, including building Xcode schemes and running package scripts.
• build_schemes.sh: Builds and tests all Xcode schemes in your project.
• Packages/run_all_scripts.sh: Runs all Swift package related scripts (build, test, clean).
• Packages/run_swift_builds.sh: Builds all Swift packages.
• Packages/run_swift_tests.sh: Runs tests for all Swift packages.
• Packages/remove_package_resolved.sh: Deletes all Package.resolved files.
• Packages/remove_build_folders.sh: Deletes all .build folders.

Cleanup Scripts Explained

• remove_package_resolved.sh: Forces Swift Package Manager to re-download dependencies, ensuring you have the latest versions.
• remove_build_folders.sh: Frees up disk space and helps prevent build issues.

This system provides a basic, but useful, way to automate your local builds and tests. You can customize these scripts to fit your specific project needs.

Github Actions

You can easily integrate these scripts into your GitHub Actions workflow to automate CI in the cloud. Here’s how you can set up a basic workflow to run your CI scripts:

1. Create a workflow file: In your repository, create a file in .github/workflows directory, for example, ci.yml.

2. Set up the workflow: Here’s an example workflow that checks out your code and runs the run_ci.sh script:

   name: Chimera CI
   
   on:
     push:
       branches: [ main ]
     pull_request:
       branches: [ main ]
   
   jobs:
     build:
       runs-on: ubuntu-latest
   
       steps:
       - name: Checkout code
         uses: actions/checkout@v3
   
       - name: Make scripts executable
         run: chmod +x *.sh Packages/*.sh
   
       - name: Run Chimera CI
         run: ./run_ci.sh

   This workflow does the following:

   • name: Chimera CI: Sets the name of your workflow.
   • on:: Configures when the workflow will run. In this case, it runs on pushes to the main branch and pull requests targeting the main branch.
   • jobs:: Defines the jobs to be executed in the workflow.
     • build:: Defines a job named build.
       • runs-on: ubuntu-latest: Specifies that this job will run on the latest version of Ubuntu.
       • steps:: A list of steps to execute in the job.
         • actions/checkout@v3: This action checks out your repository to the workflow workspace.
         • chmod +x *.sh Packages/*.sh: Makes all shell scripts executable.
         • ./run_ci.sh: Runs the main CI script.

Todo:

• Try to run this on github actions
• Create a github action that builds and tests an array of remote projects.
• Add example project that runs in github action in the cloud
• Log progress. And failures in a .log file