Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

buildbot steps need description and descriptionDone #337

Closed
edunham opened this issue Apr 22, 2016 · 4 comments
Closed

buildbot steps need description and descriptionDone #337

edunham opened this issue Apr 22, 2016 · 4 comments

Comments

@edunham
Copy link
Contributor

@edunham edunham commented Apr 22, 2016

Waterfall currently just says "test" on all test steps. It would be better to have a short description of each step, or even just the full text of the command for that step.

Buildbot docs at http://docs.buildbot.net/latest/manual/cfg-buildsteps.html#common-parameters describe description and descriptionDone, and here is an example of them in use.

Steps are created here with configs drawn from here.

@aneeshusa, what's your opinion on whether this should be implemented by adding the information to the yaml file or by inferring it from the commands?

@edunham edunham added the enhancement label Apr 22, 2016
@aneeshusa
Copy link
Member

@aneeshusa aneeshusa commented Apr 22, 2016

I want to keep the YAML file as simple as possible, so I'd say these should be generated from the commands. Given a shell command such as ./mach build --dev, we can use Running './mach build --dev' for the description, and simply ./mach build --dev for descriptionDone.

I think this could be added to make_step fairly easily.

@aneeshusa aneeshusa added the E-easy label Apr 22, 2016
@aneeshusa
Copy link
Member

@aneeshusa aneeshusa commented Apr 22, 2016

For description, we could also have this change based on the Step class: Compiling, Testing, Running, and not include the command as the docs say to keep the description field as a single imperfect-tense verb.

@UK992
Copy link
Contributor

@UK992 UK992 commented Jul 12, 2016

I want to claim this

@KiChjang
Copy link
Member

@KiChjang KiChjang commented Jul 12, 2016

@UK992 It's yours!

@KiChjang KiChjang added the C-assigned label Jul 12, 2016
@jdm jdm added the C-has open PR label Jul 27, 2016
bors-servo added a commit that referenced this issue Aug 4, 2016
Add description to buildbot steps

Fixes #337

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/saltfs/438)
<!-- Reviewable:end -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.