Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshdk/drone-skip-pipeline
🤖 DroneCI plugin to skip pipelines based on files changes
https://github.com/joshdk/drone-skip-pipeline
Last synced: about 5 hours ago
JSON representation
🤖 DroneCI plugin to skip pipelines based on files changes
- Host: GitHub
- URL: https://github.com/joshdk/drone-skip-pipeline
- Owner: joshdk
- License: mit
- Created: 2021-11-13T22:31:23.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-14T00:24:04.000Z (over 1 year ago)
- Last Synced: 2024-06-20T00:32:28.450Z (5 months ago)
- Language: Go
- Size: 54.7 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![License][license-badge]][license-link]
[![Actions][github-actions-badge]][github-actions-link]
[![Releases][github-release-badge]][github-release-link]
# DroneCI Skip Pipeline
🤖 DroneCI plugin to skip pipelines based on files changes
## 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.
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.
## Usage
This plugin can be added to your `.drone.yml` as a new step within an existing pipeline.
```yaml
steps:
- name: debug
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.1
settings:
rules:
- package.json
- app/
```
If your repository is private, a `GITHUB_TOKEN` environment variable must also be configured.
```yaml
steps:
- name: drone-skip-pipeline
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.1
...
environment:
GITHUB_TOKEN:
from_secret: GITHUB_TOKEN
```
You can then reconfigure any existing clone steps to depend on this new step.
```yaml
- name: clone
...
depends_on:
- drone-skip-pipeline
```
You must also disable automatic cloning at the pipeline level.
```yaml
clone:
disable: true
```
In order to provide some level of feature parity for older versions of DroneCI that do not support pipeline skipping, you can configure the `touch` setting with a filename that will be created in the event that the pipeline should be skipped.
The existence of file can then be checked for in subsequent steps, where commands can then be skipped where appropriate.
You may also need to configure the `failure` property, in order to ignore the non-zero exit code.
```yaml
steps:
- name: debug
image: ghcr.io/joshdk/drone-skip-pipeline:v0.2.1
failure: ignore
settings:
rules:
- package.json
- app/
touch: .skip-pipeline
```
## License
This code is distributed under the [MIT License][license-link], see [LICENSE.txt][license-file] for more information.
[github-actions-badge]: https://github.com/joshdk/drone-skip-pipeline/workflows/Build/badge.svg
[github-actions-link]: https://github.com/joshdk/drone-skip-pipeline/actions
[github-release-badge]: https://img.shields.io/github/release/joshdk/drone-skip-pipeline/all.svg
[github-release-link]: https://github.com/joshdk/drone-skip-pipeline/releases
[license-badge]: https://img.shields.io/badge/license-MIT-green.svg
[license-file]: https://github.com/joshdk/drone-skip-pipeline/blob/master/LICENSE.txt
[license-link]: https://opensource.org/licenses/MIT