Rename the JOB_NAME_BUILDERNAME 'desc' property to 'name'

RESOLVED FIXED

Status

P4
normal
RESOLVED FIXED
5 years ago
4 years ago

People

(Reporter: emorley, Assigned: sabergeass, Mentored)

Tracking

Details

(Whiteboard: [good first bug][lang=python])

User Story

Thank you for helping out with Treeherder!

You can find us on IRC at irc://irc.mozilla.org/treeherder

Here's some links to help get you started.

Project page:
https://wiki.mozilla.org/Auto-tools/Projects/Treeherder

Repo locations and links to set up a development version of the software:
https://wiki.mozilla.org/Auto-tools/Projects/Treeherder#Getting_Started

Interacting with us:
https://wiki.mozilla.org/Auto-tools/Projects/Treeherder#Contributing

A-Team general reference, coding style guides:
http://ateam-bootcamp.readthedocs.org

Attachments

(1 attachment)

46 bytes, text/x-github-pull-request
emorley
: review+
Details | Review | Splinter Review
(Reporter)

Description

5 years ago
In bug 1051508 there was confusion over the 'desc' property, since if I've understood correctly it is being used more as 'name':

eg:
https://github.com/mozilla/treeherder-service/blob/a596a7ab1ce8931a7e4f6f2e9e3898c0c06bc443/treeherder/etl/buildbot.py#L323

{"regex": re.compile('mozbase'), "desc": "Mozbase Unit Tests"},
{"regex": re.compile('mochitest-e10s-browser-chrome'), "desc": "Mochitest e10s Browser Chrome"},
{"regex": re.compile('mochitest-e10s-devtools-chrome'), "desc": "Mochitest e10s DevTools Browser Chrome"},

We should rename it to avoid confusion (to 'name' or whatever else is appropriate), particularly since we would like to add an actual description somewhere too.

Making this a blocker since upsetting the data-model apple cart is something I presume we'll want to do before we have too many more consumers.
(Reporter)

Comment 1

5 years ago
or 'displayName', 'friendlyName' etc
(Reporter)

Comment 2

5 years ago
Given bug 1051508 comment 6, this doesn't block.
No longer blocks: 1030636, 1051508
Priority: P2 → P3
(Reporter)

Updated

4 years ago
Priority: P3 → P4
Mentor: emorley
User Story: (updated)
Whiteboard: [good first bug]
(Reporter)

Updated

4 years ago
Whiteboard: [good first bug] → [good first bug][lang=python]
(Assignee)

Comment 3

4 years ago
Hi~ I would like to work on this bug if you can assign it to me. Could you give it to me and tell me more about this issue? In my understanding, I just need to change all 'desc' which in the whole buildbot.py into 'name' or other variable name can be easily understand. Is it right?
(Reporter)

Comment 4

4 years ago
Yup that's correct :-)
(Reporter)

Updated

4 years ago
Assignee: nobody → sabergeass
Status: NEW → ASSIGNED
(Assignee)

Comment 5

4 years ago
(In reply to Ed Morley [:emorley] from comment #4)

Thank you for your trust :-)

Could you give me a example? I'm not sure what kind of name is appropriate.
(Assignee)

Comment 6

4 years ago
For example, is just change "desc" to "name" will enough? 
>  {..... "desc": "Mozbase Unit Tests"}, -> {....."name":"Mozbase Unit Tests"}
(Reporter)

Comment 7

4 years ago
Yeah "name" makes sense I think, given that's what we call it later on (https://github.com/mozilla/treeherder/blob/9e29351e6a0dafa9e91290599f37e85aadc659fd/treeherder/etl/buildbot.py#L980). Thanks! :-)
(Assignee)

Comment 8

4 years ago
Created attachment 8599862 [details] [review]
first version patch

Hi~ I had create a pull request. If it works fine, could you offer me more bugs about treeherder? I just want fix more and learn more. Thank you :)
Attachment #8599862 - Flags: review?(emorley)
(In reply to MikeLing from comment #8) 
> Hi~ I had create a pull request. If it works fine, could you offer me more
> bugs about treeherder? I just want fix more and learn more. Thank you :)

Yes, good-first-bugs are available off the Bugsahoy link, here
https://wiki.mozilla.org/Auto-tools/Projects/Treeherder#Contributing

If you want to broaden your bug search, you can also look through 'All open bugs' directly below it. There are around 500 or so at present.
(Reporter)

Updated

4 years ago
Summary: Rename the job 'desc' property to 'name' → Rename the JOB_NAME_BUILDERNAME 'desc' property to 'name'
(Reporter)

Comment 10

4 years ago
Comment on attachment 8599862 [details] [review]
first version patch

This looks great & passes tests - thank you :-)

If you update the commit message + rebase, then force push to the same PR I'll merge it for you.

I'd recommend a commit message something like:
"Bug 1052479 - Rename the JOB_NAME_BUILDERNAME 'desc' property to 'name'"
(without quotes)
Attachment #8599862 - Flags: review?(emorley) → review+
(Assignee)

Comment 11

4 years ago
(In reply to Ed Morley [:emorley] from comment #10)

Hmm, I think everything should be fine this time. :)

I would like to keep contribute to Treeherder project, but I found many first-good-bug is js and I know very little about that(but I can learn and try to fix it) and I don't if it will be ok.

Maybe I should learn more information on IRC :)
(In reply to MikeLing from comment #11)
> (In reply to Ed Morley [:emorley] from comment #10)
> 
> I would like to keep contribute to Treeherder project, but I found many
> first-good-bug is js and I know very little about that(but I can learn and
> try to fix it) and I don't if it will be ok.

If you'd like to contribute in other languages you are familiar with already, you can also find many other Mozilla products and projects here
http://www.whatcanidoformozilla.org
http://www.whatcanidoformozilla.org/#!/progornoprog/proglang (select your langs from this point)
(Reporter)

Comment 14

4 years ago
(In reply to MikeLing from comment #11)
> (In reply to Ed Morley [:emorley] from comment #10)
> 
> Hmm, I think everything should be fine this time. :)

Yeah that's great, thank you - have merged manually since needed a rebase against latest changes on master.
Looking forward to you working on something else soon!
Status: ASSIGNED → RESOLVED
Last Resolved: 4 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.