WordPress.org
Get WordPress

Make WordPress Core

Opened 17 months ago

Last modified 3 months ago

#56150 new task (blessed)

Add GitHub Action job summaries to workflows

Reported by: desrosj's profile desrosj Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version:
Component: Build/Test Tools Keywords: good-first-bug needs-testing
Focuses: performance Cc:

Description

In May, GitHub released ​Job Summaries for GitHub Actions, which allows markdown or raw HTML to be displayed on the workflow run summary page for jobs.

This ticket is for exploring ways to use this feature in the WordPress Core workflows to make it easier to understand the data and outcomes buried in each step's log output within a job.

Change History (11)

#1 @desrosj
17 months ago

  • Keywords good-first-bug added

Was chatting with @johnbillion a bit in Slack about how this feature could be utilized in Core. He ​shared one example from a project of his.

After some discussion, the most apparent place that this could be useful is within the PHPUnit workflow to display a table with data around how many:

  • tests were identified as risky.
  • tests were skipped.
  • tests encountered errors.
  • total tests were found.
  • assertions were made.
  • etc.

I'm marking this as good-first-bug as it's self-contained, and a great way to dig in to learn more about GitHub Actions.

This ticket was mentioned in ​PR #3013 on ​WordPress/wordpress-develop by ​sarahricker.
17 months ago #2

  • Keywords has-patch added

Trac ticket: https://core.trac.wordpress.org/ticket/56150

This ticket was mentioned in ​Slack in #core by desrosj. ​View the logs.
16 months ago

#5 @desrosj
9 months ago

I think it would be great to use this feature as a way to surface the results of the performance testing introduced in [55459].

The data is submitted to an external dashboard and is visible within the logs, but having it presented as a job summary would be really neat. cc/@joemcgill @flixos90 @mukesh27

#6 @joemcgill
9 months ago

  • Focuses performance added
  • Keywords needs-patch added; has-patch removed
  • Milestone changed from Future Release to 6.3

I dig this idea. Thanks @desrosj!

#7 @joemcgill
6 months ago

  • Type changed from enhancement to task (blessed)

I still really like the idea of displaying automated performance benchmarks on PRs using this method, but doing so should be preceded by #58358.

Since this ticket is only related to our build tools I'm changing it to a task ticket because it can be worked on outside the normal release cycle. @desrosj feel free to change it back if that's incorrect.

#8 @mukesh27
5 months ago

  • Milestone changed from 6.3 to Future Release

#10 @whyisjake
3 months ago

  • Keywords needs-testing added; needs-patch removed

Reviewing tickets with @mikestraw at WCUS. Has a patch, needs testing.

Last edited 3 months ago by whyisjake (previous) (diff)

This ticket was mentioned in ​Slack in #core-performance by swissspidy. ​View the logs.
3 months ago

#12 @swissspidy
3 months ago

In 56506:

Build/Test Tools: Compare results in performance measurement workflow.

This extends the performance test workflow added in [55459] to also run tests against the target branch (if running on a pull request) or the previous commit (if running on trunk).

Those results are then compared with the ones from the current commit, and the difference is displayed as a GitHub Actions workflow summary for convenience.

Props mukesh27, flixos90, desrosj, joemcgill, swissspidy.
Fixes #58358, #58359.
See #56150.

Note: See TracTickets for help on using tickets.