Opened 6 years ago
Last modified 4 years ago
#2929 new task
document BuildStep renderables variable
Reported by: | vlovich | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | 0.9.+ |
Version: | 0.8.9 | Keywords: | docs, simple |
Cc: |
Description
Documentation for the 'renderables' property is missing which is needed for writing custom steps. Probably add a description in the buildbot customization section?
Change History (4)
comment:1 Changed 6 years ago by dustin
- Keywords docs simple added
- Milestone changed from undecided to 0.9.+
comment:2 Changed 5 years ago by sa2ajj
I'm curious why http://docs.buildbot.net/latest/manual/cfg-properties.html#using-properties-in-steps and http://docs.buildbot.net/latest/manual/cfg-properties.html#custom-renderables are not good enough documentation.
Is it not easy to find it? Or something else?
comment:3 Changed 5 years ago by vlovich
Something else. This is referring to the "renderables" property on the BuildStep? class that you extend for custom steps. BuildBot reads this variable to render those properties on the custom step before invoking run. There's not (or wasn't when I wrote the bug) any such documentation describing this process.
Good idea