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

Bug 1863187 - Add "how to run locally" information into Artifacts and Debugging Tools tab. #7869

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

arai-a
Copy link
Contributor

@arai-a arai-a commented Nov 9, 2023

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

(this replaces #7868 for the "how to run locally" part.
#7868 could still be used with some rework, to show the single-line description field in the TreeHerder UI.)

Added one feature and one minor tweak:

  • Add "How to run locally" section to "Artifacts and Debugging Tools" tab
    • This shows the content of extra.local-run field of the job YAML file
    • The field can contain the commands, explanation, and links to document
  • Add "Artifacts" header above artifacts list

This modifies the database in the following way:

  • Add local_run column to job_type table
    • this column defaults to empty string

the job's extra.local-run field is retrieved from the task cluster's task query's result.

Here's screenshot with this patch

local-run

the data is ingested from https://treeherder.mozilla.org/jobs?repo=try&revision=efa598d1c2de420094d36619ed03af1cbbff7939

@arai-a
Copy link
Contributor Author

arai-a commented Nov 9, 2023

possible followup:

  • maybe we could format the content with markdown, instead of using <pre> (if introducing markdown parser there isn't too much troublesome)

@arai-a arai-a force-pushed the local-run-extra branch 2 times, most recently from bcea732 to 196c65f Compare November 9, 2023 06:44
@codecov-commenter
Copy link

codecov-commenter commented Nov 9, 2023

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (cf69e68) 76.83% compared to head (37b06a6) 76.85%.
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7869      +/-   ##
==========================================
+ Coverage   76.83%   76.85%   +0.01%     
==========================================
  Files         538      539       +1     
  Lines       26621    26641      +20     
  Branches     3360     3365       +5     
==========================================
+ Hits        20455    20475      +20     
  Misses       6001     6001              
  Partials      165      165              
Files Coverage Δ
tests/webapp/api/test_jobs_api.py 100.00% <ø> (ø)
treeherder/etl/job_loader.py 87.02% <ø> (ø)
treeherder/etl/jobs.py 95.06% <100.00%> (+0.29%) ⬆️
treeherder/etl/taskcluster_pulse/handler.py 57.61% <100.00%> (+0.20%) ⬆️
...eherder/model/migrations/0031_jobtype_local_run.py 100.00% <100.00%> (ø)
treeherder/model/models.py 82.30% <100.00%> (+0.02%) ⬆️
treeherder/webapp/api/jobs.py 82.22% <ø> (ø)
treeherder/webapp/api/serializers.py 88.15% <ø> (ø)
ui/shared/JobArtifacts.jsx 92.30% <82.35%> (+1.13%) ⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants