mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-08 08:30:43 +00:00
17b8867b96
The goal here is to make consistent use of configuration environment variables prefixed `WOODPECKER_`. Where several variants existed, this PR aims to remove all but one option, leaving the most explicit. This PR only changes server and agent code, but not documentation, in order to keep the PR digestible. Once we have consensus that this is correct, I'll change docs accordingly. User (rather: admin) facing changes in this PR: - In general, support for all server and agent config environment variables (env vars) starting with `DRONE_` is removed. The according `WOODPECKER_*` variables must be used instead. - The env var `WOODPECKER_HOST` replaces `DRONE_HOST`, and `DRONE_SERVER_HOST`. - The env var `WOODPECKER_AGENT_SECRET` is used to configure the shared secret which agents use to authenticate against the server. It replaces `WOODPECKER_SECRET`, `DRONE_SECRET`, `WOODPECKER_PASSWORD`, `DRONE_PASSWORD`, and `DRONE_AGENT_SECRET`. - The env var `WOODPECKER_DATABASE_DRIVER` replaces `DRONE_DATABASE_DRIVER` and `DATABASE_DRIVER`. - The env var `WOODPECKER_DATABASE_DATASOURCE` replaces `DRONE_DATABASE_DATASOURCE` and `DATABASE_CONFIG`. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| .woodpecker | ||
| agent | ||
| charts | ||
| cli | ||
| cmd | ||
| docs | ||
| drone-go | ||
| pipeline | ||
| server | ||
| shared | ||
| vendor | ||
| version | ||
| web | ||
| .changelog.yml | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| BUILDING | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| docker-compose.example.yml | ||
| Dockerfile | ||
| Dockerfile.agent | ||
| Dockerfile.agent.alpine | ||
| Dockerfile.alpine | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| tools.go | ||
Woodpecker
Woodpecker is a community fork of the Drone CI system.
Support
Please consider to donate and become a backer. 🙏 [Become a backer]
Usage
.woodpecker.yml
- Place your pipeline in a file named
.woodpecker.ymlin your repository - Pipeline steps can be named as you like
- Run any command in the commands section
# .woodpecker.yml
pipeline:
build:
image: debian
commands:
- echo "This is the build step"
a-test-step:
image: debian
commands:
- echo "Testing.."
Build steps are containers
- Define any Docker image as context
- Install the needed tools in custom Docker images, use them as context
pipeline:
build:
- image: debian
+ image: mycompany/image-with-awscli
commands:
- aws help
File changes are incremental
- Woodpecker clones the source code in the beginning pipeline
- Changes to files are persisted through steps as the same volume is mounted to all steps
# .woodpecker.yml
pipeline:
build:
image: debian
commands:
- touch myfile
a-test-step:
image: debian
commands:
- cat myfile
Plugins are straightforward
- If you copy the same shell script from project to project
- Pack it into a plugin instead
- And make the yaml declarative
- Plugins are Docker images with your script as an entrypoint
# Dockerfile
FROM laszlocloud/kubectl
COPY deploy /usr/local/deploy
ENTRYPOINT ["/usr/local/deploy"]
# deploy
kubectl apply -f $PLUGIN_TEMPLATE
# .woodpecker.yml
pipeline:
deploy-to-k8s:
image: laszlocloud/my-k8s-plugin
template: config/k8s/service.yml
Documentation
https://woodpecker-ci.github.io/
Who uses Woodpecker?
Currently, I know of one organization using Woodpecker. With 50+ users, 130+ repos and more than 1100 builds a week.
Leave a comment if you're using it.
Contribution
License
Woodpecker is Apache 2.0 licensed with the source files in this repository having a header indicating which license they are under and what copyrights apply.
Files under the docs/ folder are licensed under Creative Commons Attribution-ShareAlike 4.0 International Public License.