Skip to content

Commit

Permalink
Updates the examples in the README file to version 3
Browse files Browse the repository at this point in the history
  • Loading branch information
ecampidoglio committed Feb 6, 2025
1 parent 7f79e8c commit d0d740d
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Using the Cake action from a GitHub Actions workflow is as simple as referencing
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
```
The Cake action will look for a script named `build.cake` in your repository's root directory and run it for you using the [Cake Tool](https://www.nuget.org/packages/Cake.Tool/). You can also specify the path to your Cake script using the `script-path` option. If you are using a [Cake Frosting](https://cakebuild.net/docs/running-builds/runners/cake-frosting) project instead, you must specify the path to your `.csproj` file with the `project-path` parameter.
Expand All @@ -27,7 +27,7 @@ If your Cake script is located somewhere other than the root directory of your p
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
script-path: path/to/script.cake
```
Expand All @@ -39,7 +39,7 @@ If you are using [Cake Frosting](https://cakebuild.net/docs/running-builds/runne
```yml
steps:
- name: Run Cake Frosting
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
project-path: path/to/build.csproj
```
Expand All @@ -51,7 +51,7 @@ You'll likely want to specify which task to run out of the ones defined in the C
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
target: Task-To-Run
```
Expand All @@ -63,7 +63,7 @@ You can adjust the amount of information Cake sends to the build log by changing
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
verbosity: Diagnostic
```
Expand All @@ -77,7 +77,7 @@ While developing a script, you'll sometimes want to see which tasks would be tri
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
dry-run: true
```
Expand All @@ -91,7 +91,7 @@ If your script defines any custom parameters, you can specify arguments for them
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
arguments: |
name: value
Expand All @@ -109,7 +109,7 @@ If you need to [use a specific version of Cake](https://cakebuild.net/docs/tutor
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
cake-version: 0.30.0
```
Expand All @@ -119,7 +119,7 @@ If you're pinning your Cake version using a [tool manifest file](https://docs.mi
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
cake-version: tool-manifest
```
Expand All @@ -135,7 +135,7 @@ For older versions of Cake, you need to explicitly [bootstrap](https://cakebuild
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
cake-bootstrap: explicit
cake-version: 0.38.5
Expand All @@ -146,7 +146,7 @@ If you're using Cake 1.0.0 or later and wish to opt out of the automatic bootstr
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
cake-bootstrap: skip
```
Expand All @@ -172,7 +172,7 @@ jobs:
- name: Get the sources
uses: actions/checkout@v1
- name: Run the build script
uses: cake-build/cake-action@v2
uses: cake-build/cake-action@v3
with:
target: Build
```
Expand Down

0 comments on commit d0d740d

Please sign in to comment.