Skip to content

Commit

Permalink
add more info for implement this action
Browse files Browse the repository at this point in the history
Add info for compatibility and example for implement with cocoapods
  • Loading branch information
LucasGinard authored Oct 8, 2023
1 parent 031d29a commit 6afa882
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Xcodebuild Action
# <img src="https://avatars.githubusercontent.com/u/17783361?s=48&amp;v=4" width="24" height="24"> 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)

Expand All @@ -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 ✅.<br>
## 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

Expand All @@ -32,3 +49,19 @@ with:
destination: platform=macOS
action: test
```
<details>
<summary>Example for CocoaPods:</summary>
> 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
```
</details>

0 comments on commit 6afa882

Please sign in to comment.