woodpecker-ci / woodpecker

Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.
https://woodpecker-ci.org
Apache License 2.0
4.07k stars 351 forks source link

Document workflow options #2961

Open runephilosof-karnovgroup opened 8 months ago

runephilosof-karnovgroup commented 8 months ago

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

anbraten commented 8 months ago

We kept most of them secret (undocumented) as they are just partly supported and probably get removed / moved as soon as someone has to time to refactor them.