Skip to content

Commit 84ec539

Browse files
committed
fix: Remove usage example
It seems to be interpreted by the workflow parser.
1 parent b540653 commit 84ec539

File tree

3 files changed

+12
-19
lines changed

3 files changed

+12
-19
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ steps:
2222
fetch-depth: 0
2323

2424
# Deploy your application
25-
- uses: 47ng/[email protected].0
25+
- uses: 47ng/[email protected].1
2626
env:
2727
CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
2828
CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
@@ -42,7 +42,7 @@ If you have committed the `.clever.json` file, you only need to specify
4242
the alias of the application to deploy:
4343

4444
```yml
45-
- uses: 47ng/[email protected].0
45+
- uses: 47ng/[email protected].1
4646
with:
4747
alias: my-app-alias
4848
env:
@@ -54,7 +54,7 @@ If you don't have this `.clever.json` file or you want to explicly
5454
deploy to another application, you can pass its ID:
5555

5656
```yml
57-
- uses: 47ng/[email protected].0
57+
- uses: 47ng/[email protected].1
5858
with:
5959
appID: app_facade42-cafe-babe-cafe-deadf00dbaad
6060
env:
@@ -96,7 +96,7 @@ You can set extra environment variables on the deployed application under the
9696
key=value).
9797

9898
```yml
99-
- uses: 47ng/[email protected].0
99+
- uses: 47ng/[email protected].1
100100
with:
101101
setEnv: | # <- note the pipe here..
102102
FOO=bar
@@ -136,7 +136,7 @@ you can specify a timeout in seconds after which the workflow will move on,
136136
regardless of the deployment status:
137137

138138
```yml
139-
- uses: 47ng/[email protected].0
139+
- uses: 47ng/[email protected].1
140140
with:
141141
timeout: 1800 # wait at maximum 30 minutes before moving on
142142
env:
@@ -151,7 +151,7 @@ regardless of the deployment status:
151151
Clever Cloud uses a Git remote to perform deploys. By default, if the commit you want to deploy is not a fast-forward from the commit currently deployed, the deploy will be rejected. You can pass `force: true` to force the deploy anyway:
152152

153153
```yml
154-
- uses: 47ng/[email protected].0
154+
- uses: 47ng/[email protected].1
155155
with:
156156
appID: app_facade42-cafe-babe-cafe-deadf00dbaad
157157
force: true
@@ -162,12 +162,12 @@ Clever Cloud uses a Git remote to perform deploys. By default, if the commit you
162162

163163
## Logs
164164

165-
> Support: introduced in v1.3.0
165+
> Support: introduced in v1.3.1
166166

167167
You can write the deployment logs to a file for archiving:
168168

169169
```yml
170-
- uses: 47ng/[email protected].0
170+
- uses: 47ng/[email protected].1
171171
with:
172172
logFile: ./clever-cloud-deploy.log
173173
env:
@@ -186,7 +186,7 @@ If your deployment process is susceptible to log secrets or PII, you can also
186186
disable it from printing onto the console, using the `quiet` option:
187187

188188
```yml
189-
- uses: 47ng/[email protected].0
189+
- uses: 47ng/[email protected].1
190190
with:
191191
quiet: true
192192
env:
@@ -207,7 +207,7 @@ _Note: this behaviour will be disabled if the `quiet` option is used._
207207
This action follows [SemVer](https://semver.org/).
208208

209209
To specify the version of the action to use:
210-
- `uses: 47ng/[email protected].0`: latest stable version
210+
- `uses: 47ng/[email protected].1`: latest stable version
211211
- `uses: 47ng/actions-clever-cloud@3e5402496b8d6492401ebb3134acfeccc25c3fce`: pinned to a specific Git SHA-1 (check out the [releases](https://github.com/47ng/actions-clever-cloud/releases))
212212
- `uses: docker://47ng/actions-clever-cloud:latest`: latest code from master (not recommended, as it may break: hic sunt dracones.)
213213

action.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,6 @@ inputs:
3737
required: false
3838
description: |
3939
Path to a file where to store the deployment logs.
40-
Example usage:
41-
```yaml
42-
- uses: 47ng/actions-clever-cloud@version
43-
id: deploy
44-
with:
45-
logFile: ${{ github.workspace }}/logs/clever-cloud-deploy.log
46-
```
4740
quiet:
4841
required: false
4942
default: 'false'
@@ -58,4 +51,4 @@ inputs:
5851
to be set, see https://github.com/47ng/ations-clever-cloud#safelisting
5952
runs:
6053
using: docker
61-
image: docker://47ng/actions-clever-cloud:v1.3.0
54+
image: docker://47ng/actions-clever-cloud:v1.3.1

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@47ng/actions-clever-cloud",
3-
"version": "1.3.0",
3+
"version": "1.3.1",
44
"private": true,
55
"description": "GitHub Action to deploy to Clever Cloud",
66
"main": "dist/main.js",

0 commit comments

Comments
 (0)