diff --git a/README.md b/README.md index a4ca075..8124605 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Xcodebuild Action +# Xcodebuild Action [![Tests](https://github.com/sersoft-gmbh/xcodebuild-action/actions/workflows/tests.yml/badge.svg)](https://github.com/sersoft-gmbh/xcodebuild-action/actions/workflows/tests.yml) @@ -20,6 +20,23 @@ The unprocessed command from which the executed command was resolved. E.g. paths The command that was executed by this action. This will also be printed to the action output. +## Compatibility Projects: + +You can run this action with these dependency managers: +| Type | Status | +|--------------------|:------------:| +| CocoaPods | ✅ | +| Swift Package Manager | ✅ | + +> If you are not using a dependency manager, you can still utilize this action ✅.
+ +## Action attribute +The action to perform (e.g. build, test, ...). Can also contain multiple actions, for default is **test** + +| Action | Description | +|----------|--------------------------------------------------------------------------------------------------------------| +| build | This action is used to compile the project. It generates the necessary binary files for the application. | +| test | The "test" action is used to execute tests in the project, ensuring the code functions correctly. | ## Example Usage @@ -32,3 +49,19 @@ with: destination: platform=macOS action: test ``` +
+Example for CocoaPods: + +> If the CocoaPods dependencies are already present in the repository, you don't need to do anything except passing the workspace + +```yaml +uses: sersoft-gmbh/xcodebuild-action@v3 +with: + workspace: MyApp.xcworkspace + scheme: MyApp + destination: platform=macOS + action: test +``` +
+ +