treeherder icon indicating copy to clipboard operation
treeherder copied to clipboard

Bug 1863187 - Add job description to the job info, and also add full job description tab.

Open arai-a opened this issue 1 year ago • 7 comments

for https://bugzilla.mozilla.org/show_bug.cgi?id=1863187

Added 2 feature:

  • show "job description" field into job info pane, under "job name" field
    • this shows the first line of the job's description field in the source YAML file
  • add "Full Description" tab
    • this shows the job's description field in the source YAML file
    • the field can be multi-line, and I'm about to put more info there, such as "how to run locally", and possibly a URL of document

This modifies the database in the following way:

  • job_desc table is added
    • this is used for deduplicating the description field across multiple jobs
  • job_desc_id column is added to job table
    • this contains the job_desc table's id
    • this column defaults to an empty text in job_desc table

The job's description field is retrieved via the pulse's jobInfo.summary property, that seems to be the result of the following.

https://searchfox.org/mozilla-central/rev/02841791400cf7cf5760c0cfaf31f5d772624253/taskcluster/gecko_taskgraph/transforms/task.py#2004

"task-reference": "{description} ([Treeherder job]({th_job_link}))".format(

It contains the concatenation of the job's description field and the treeherder job link. job_loader drops the treehreder job link part and uses it as description. if there's better way to get the raw description field, let me know.

Concern:

  • job_desc table will store all description values, and whenever the description is modified (such as, adding more info "how to run locally", URL of documents, etc), a new row is added, and the old row is kept around

arai-a avatar Nov 08 '23 09:11 arai-a