Skip to content

Commit

Permalink
Updates the documentation to reference v2
Browse files Browse the repository at this point in the history
  • Loading branch information
ecampidoglio committed Feb 5, 2024
1 parent 688476f commit c1bde02
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 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@v1
uses: cake-build/cake-action@v2
```
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/). All output from the Cake script will be automatically redirected to the build log for inspection.
Expand All @@ -25,7 +25,7 @@ If your script is in another location, you can specify the path with the `script
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v1
uses: cake-build/cake-action@v2
with:
script-path: path/to/script.cake
```
Expand All @@ -37,7 +37,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@v1
uses: cake-build/cake-action@v2
with:
target: Task-To-Run
```
Expand All @@ -49,7 +49,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@v1
uses: cake-build/cake-action@v2
with:
verbosity: Diagnostic
```
Expand All @@ -63,7 +63,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@v1
uses: cake-build/cake-action@v2
with:
dry-run: true
```
Expand All @@ -77,7 +77,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@v1
uses: cake-build/cake-action@v2
with:
arguments: |
name: value
Expand All @@ -93,7 +93,7 @@ By default, the Cake action will run your script using the latest _stable_ versi
```yml
steps:
- name: Run the Cake script
uses: cake-build/cake-action@v1
uses: cake-build/cake-action@v2
with:
cake-version: 0.30.0
```
Expand All @@ -103,7 +103,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@v1
uses: cake-build/cake-action@v2
with:
cake-version: tool-manifest
```
Expand Down Expand Up @@ -152,7 +152,7 @@ jobs:
- name: Get the sources
uses: actions/checkout@v1
- name: Run the build script
uses: cake-build/cake-action@v1
uses: cake-build/cake-action@v2
with:
target: Build
```
Expand Down

0 comments on commit c1bde02

Please sign in to comment.