Skip to content
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

More info for implement this action Readme #165

Merged
merged 2 commits into from
Oct 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Note that this action needs to run on macOS. All other platforms will fail!

## Inputs

See [action.yml](action.yml) for an overview of all inputs.
See [action.yml](action.yml) for an overview of all inputs.<br/>
For more information about the various inputs, also see `man xcodebuild`.

## Outputs

Expand All @@ -20,10 +21,28 @@ 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.


## Example Usage

Use the following snippet when you want to run tests configured with the `MyApp` scheme inside a `MyApp` Xcode project:
<details>
<summary>Example using a Swift Package</summary>

**Note:** If you have multiple products in your package, Xcode will auto-generate a `my-tool-Package` scheme, where `my-tool` is the name of your package. If you only have one product, or wish to only build a specific product, you can use the product name as scheme directly.

```yaml
uses: sersoft-gmbh/xcodebuild-action@v3
with:
spm-package: './'
scheme: my-tool-Package
destination: platform=macOS
action: test
```
</details>

<details>
<summary>Example using an Xcode project (<code>xcodeproj</code>)</summary>

This will run tests configured with the `MyApp` scheme inside a `MyApp` Xcode project.

```yaml
uses: sersoft-gmbh/xcodebuild-action@v3
with:
Expand All @@ -32,3 +51,21 @@ with:
destination: platform=macOS
action: test
```
</details>

<details>
<summary>Example using an Xcode workspace (<code>xcworkspace</code>)</summary>

This will run tests configured with the `MyApp` scheme inside a `MyApp` Xcode workspace.

**Note for CocoaPods:** Restoring the CocoaPods dependencies has to be done before running this action.

```yaml
uses: sersoft-gmbh/xcodebuild-action@v3
with:
workspace: MyApp.xcworkspace
scheme: MyApp
destination: platform=macOS
action: test
```
</details>