mirror of
https://github.com/joshdk/drone-skip-pipeline
synced 2024-05-11 15:46:02 +02:00
docs: update for v0.2.1 release (#18)
This commit is contained in:
parent
bd8dd6e45a
commit
99b912893c
10
README.md
10
README.md
|
@ -9,8 +9,8 @@
|
||||||
## Motivations
|
## Motivations
|
||||||
|
|
||||||
This DroneCI plugin enables you skip (or short-circuit) a pipeline based on the files changed as part of the current pull request being built.
|
This DroneCI plugin enables you skip (or short-circuit) a pipeline based on the files changed as part of the current pull request being built.
|
||||||
You can avoid running a given pipeline if none of the files involved in that pipeline have changed.
|
You can avoid running a given pipeline if none of the files involved in that pipeline were changed.
|
||||||
This plugin also uses the Github API in order to determine the list of files changes, and as such can be used **without** needing a clone step to be run first.
|
This plugin also uses the GitHub API in order to determine the list of files changes, and as such can be used **without** needing a clone step to be run first.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ This plugin can be added to your `.drone.yml` as a new step within an existing p
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- name: debug
|
- name: debug
|
||||||
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.0
|
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.1
|
||||||
settings:
|
settings:
|
||||||
rules:
|
rules:
|
||||||
- package.json
|
- package.json
|
||||||
|
@ -31,7 +31,7 @@ If your repository is private, a `GITHUB_TOKEN` environment variable must also b
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- name: drone-skip-pipeline
|
- name: drone-skip-pipeline
|
||||||
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.0
|
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.1
|
||||||
...
|
...
|
||||||
environment:
|
environment:
|
||||||
GITHUB_TOKEN:
|
GITHUB_TOKEN:
|
||||||
|
@ -63,7 +63,7 @@ You may also need to configure the `failure` property, in order to ignore the no
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
- name: debug
|
- name: debug
|
||||||
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.0
|
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.1
|
||||||
failure: ignore
|
failure: ignore
|
||||||
settings:
|
settings:
|
||||||
rules:
|
rules:
|
||||||
|
|
Loading…
Reference in New Issue