Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marghidanu/werk
Dead simple task runner
https://github.com/marghidanu/werk
cli container docker executor parallel-jobs shell task-runner werk
Last synced: 27 days ago
JSON representation
Dead simple task runner
- Host: GitHub
- URL: https://github.com/marghidanu/werk
- Owner: marghidanu
- License: mit
- Created: 2020-09-07T08:53:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T15:41:36.000Z (10 months ago)
- Last Synced: 2024-08-04T01:07:46.503Z (4 months ago)
- Topics: cli, container, docker, executor, parallel-jobs, shell, task-runner, werk
- Language: Crystal
- Homepage:
- Size: 142 KB
- Stars: 27
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - werk - Dead simple task runner with concurrent support, ideal for local CI (Processes and Threads)
README
# werk
Dead simple task runner. Now with support for Docker.
## Build status
[](https://github.com/marghidanu/werk/actions)
## Installation
You can follow the installation guide available [here](https://github.com/marghidanu/werk/wiki/Installation).
## Documentation
For more information on how to get started, please check the [wiki](https://github.com/marghidanu/werk/wiki/Guide).
## Features
- [x] Automatic determination of the execution plan
- [x] Parallel jobs execution
- [x] Shell executor
- [x] Docker executor
- [x] Real-time output support for parallel jobs
- [x] Simple configuration DSL based on YAML
- [x] Execution report
- [ ] Web UI for browsing the execution reports (?)
- [x] Enable logging
## Example
Create a **werk.yml** with the following content:
```yaml
version: "1"
description: "Manage Werk with Werk"
jobs:
main:
description: "Build application"
executor: local
commands:
- shards build
needs:
- lint
- test
lint:
description: "Lint code"
executor: docker
image: veelenga/ameba
commands:
- ameba
can_fail: true
test:
description: "Test code"
executor: local
commands:
- crystal spec
docs:
description: Generate API documentation
executor: local
commands:
- crystal docs
- open docs/index.html
silent: true
```
after that, you can run
```
werk run
```
You can also start individual jobs by specifying a target like this:
```
werk run lint
```
Here's another example; in this case, I'm building Werk using itself.
[](https://asciinema.org/a/ssMl6y1R2RcaDgfTHj5uJejzH)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Tudor Marghidanu](https://github.com/marghidanu) - creator and maintainer