woodpecker
woodpecker copied to clipboard
Document workflow options
Component
other
Describe the bug
https://github.com/woodpecker-ci/woodpecker/blob/23f58fc07a874c821b68fe30bb2733800e8d3301/pipeline/frontend/yaml/types/container_test.go#L29-L72 lists a lot of workflow options that are undocumented.
They should appear on https://woodpecker-ci.org/docs/usage/workflow-syntax or https://woodpecker-ci.org/docs/usage/advanced-usage.
System Info
v2.0.0
Additional context
List of undocumented options
cpu_quota: 11
cpuset: 1,2
cpu_shares: 99
devices:
- /dev/ttyUSB0:/dev/ttyUSB0
dns: 8.8.8.8
dns_search: example.com
extra_hosts:
- somehost:162.242.195.82
- otherhost:50.31.209.229
network_mode: bridge
networks:
- some-network
- other-network
pull: true # is mentioned under the documentation for `image:`, but should also have its own.
privileged: true
shm_size: 1kb
mem_limit: 1kb
memswap_limit: 1kb
volumes:
- /etc/configs:/etc/configs/:ro # ability to use `:ro` is not documented on https://woodpecker-ci.org/docs/usage/volumes
tmpfs:
- /var/lib/test
ports:
- 8080
Validations
- [X] Read the Contributing Guidelines.
- [X] Read the docs.
- [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
- [X] Checked that the bug isn't fixed in the
next
version already [https://woodpecker-ci.org/faq#which-version-of-woodpecker-should-i-use] - [X] Check that this is a concrete bug. For Q&A join our Discord Chat Server or the Matrix room.