Skip to content

Commit

Permalink
fix: Remove usage example
Browse files Browse the repository at this point in the history
It seems to be interpreted by the workflow parser.
  • Loading branch information
franky47 committed Oct 6, 2022
1 parent b540653 commit 84ec539
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 19 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ steps:
fetch-depth: 0

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

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

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

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

```yml
- uses: 47ng/[email protected].0
- uses: 47ng/[email protected].1
with:
timeout: 1800 # wait at maximum 30 minutes before moving on
env:
Expand All @@ -151,7 +151,7 @@ regardless of the deployment status:
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:

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

## Logs

> Support: introduced in v1.3.0
> Support: introduced in v1.3.1

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

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

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

To specify the version of the action to use:
- `uses: 47ng/[email protected].0`: latest stable version
- `uses: 47ng/[email protected].1`: latest stable version
- `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))
- `uses: docker://47ng/actions-clever-cloud:latest`: latest code from master (not recommended, as it may break: hic sunt dracones.)

Expand Down
9 changes: 1 addition & 8 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,6 @@ inputs:
required: false
description: |
Path to a file where to store the deployment logs.
Example usage:
```yaml
- uses: 47ng/actions-clever-cloud@version
id: deploy
with:
logFile: ${{ github.workspace }}/logs/clever-cloud-deploy.log
```
quiet:
required: false
default: 'false'
Expand All @@ -58,4 +51,4 @@ inputs:
to be set, see https://github.com/47ng/ations-clever-cloud#safelisting
runs:
using: docker
image: docker://47ng/actions-clever-cloud:v1.3.0
image: docker://47ng/actions-clever-cloud:v1.3.1
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@47ng/actions-clever-cloud",
"version": "1.3.0",
"version": "1.3.1",
"private": true,
"description": "GitHub Action to deploy to Clever Cloud",
"main": "dist/main.js",
Expand Down

0 comments on commit 84ec539

Please sign in to comment.