refactor(ci): Separate Build/Test and Documentation Workflows #9
Conversation
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
This commit introduces a major refactoring of the CI/CD pipeline for improved efficiency, clarity, and robustness. - **Workflow Separation:** The CI process is now split into two distinct workflows: `swift-ci.yml` for testing and `documentation.yml` for deploying docs. This prevents unnecessary documentation deployments on pull requests. - **Documentation Fix:** The `documentation.yml` workflow has been updated to use a more robust deployment action (`JamesIves/github-pages-deploy-action`) and now creates a `.nojekyll` file to prevent GitHub Pages from incorrectly trying to build a Jekyll site. - **Example App Validation:** The main `swift-ci.yml` workflow now includes a separate job to build the `PactKit-iOS-Example` app. This serves as a crucial integration test, ensuring the library builds and links correctly in a real application environment. - **Concurrency:** A concurrency group has been added to both workflows to automatically cancel redundant runs, saving CI resources.
ryan-son
added
bug
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.
Description
This PR introduces a major refactoring of the CI/CD pipeline to improve efficiency, clarity, and robustness, inspired by best practices from mature open-source projects.
The key goals are to speed up CI runs, provide better integration validation, and make the overall workflow system more modular and maintainable.
Key Changes & Rationale
1. Workflow Separation
ci.yml: Now exclusively handles building the library, running tests, and building the example app. It runs on all pushes and pull requests.documentation.yml: A new workflow dedicated to generating and deploying DocC documentation. It now runs only on pushes tomain.2. Example App Integration Test
build-example-appjob has been added toswift-ci.yml.xcodebuild, acting as a vital integration test that verifies thatPactKitCorecan be successfully consumed by a client application.3. Caching Strategy for Performance
test-and-build-libraryjob: Caches the.builddirectory, which is the artifact folder for theswift testcommand.build-example-appjob: Caches the~/Library/Developer/Xcode/DerivedDatadirectory, which is the artifact folder forxcodebuild.4. Concurrency Control
concurrencyblock to automatically cancel in-progress runs when new commits are pushed to the same branch, saving time and resources.