Added grouping workflow to the build logs of GitHub action

matlab-actions / run-build

Run a build using the MATLAB build tool.

BSD 3-Clause "New" or "Revised" License

14 stars 6 forks source link

Added grouping workflow to the build logs of GitHub action #28

Closed nbhoski closed 7 months ago

nbhoski commented 7 months ago

What this PR contains

This PR contains the changes that integrate MATLAB buildtool plugin with GitHub actions
This code contains BuildTaskGroupPlugin which adds GitHubs workflow command ::group:: before each task run and also adds ::endgroup:: at the end of each task run.
With this, each build task is grouped using a dropdown arrow in the log as shown below

Once user click on each build task it will expand it and show the task's run log

sameagen-MW commented 7 months ago

It seems a little bit strange to transition directly from "Run command" to the task names. Maybe we could add a standard prefix or suffix to increase clarify?

Something like "task" to make it "build task", "test task", etc...

It's a little bit unfortunate that because we're using the runCommand function we can't customize that "Run command" message.

acampbel commented 7 months ago

It seems a little bit strange to transition directly from "Run command" to the task names. Maybe we could add a standard prefix or suffix to increase clarify?

Something like "task" to make it "build task", "test task", etc...

It's a little bit unfortunate that because we're using the runCommand function we can't customize that "Run command" message.

Is this something that we can avoid with a bit of refactoring?

acampbel commented 7 months ago

It seems a little bit strange to transition directly from "Run command" to the task names. Maybe we could add a standard prefix or suffix to increase clarify? Something like "task" to make it "build task", "test task", etc... It's a little bit unfortunate that because we're using the runCommand function we can't customize that "Run command" message.

Is this something that we can avoid with a bit of refactoring?

To be clear, can we refactor to take "Run Command" out and then also think a bit more about what the section titles should be? One option is just the name of the task. What are alternatives? Something like:

deploy Running "deploy" task Build Task: deploy Task: deploy

nbhoski commented 7 months ago

Consider this as a prototype @sameagen-MW thanks for your suggestions will incorporate it in my actual implementation. I will reiterate this with a spec first and shall open a new PR

mcafaro commented 7 months ago

It seems a little bit strange to transition directly from "Run command" to the task names. Maybe we could add a standard prefix or suffix to increase clarify?

Something like "task" to make it "build task", "test task", etc...

It's a little bit unfortunate that because we're using the runCommand function we can't customize that "Run command" message.

I agree "Run command" doesn't feel like it belongs at the same level as tasks.

Is it possible to nest these folds? I think ideally you'd have something like:

Collapsed:

> Run command
> Run build

Expanded:

> Run command
v Run build
  > build
  > test
  > deploy

nbhoski commented 7 months ago

It seems a little bit strange to transition directly from "Run command" to the task names. Maybe we could add a standard prefix or suffix to increase clarify? Something like "task" to make it "build task", "test task", etc... It's a little bit unfortunate that because we're using the runCommand function we can't customize that "Run command" message.

I agree "Run command" doesn't feel like it belongs at the same level as tasks.

Is it possible to nest these folds? I think ideally you'd have something like:

Collapsed:
> Run command
> Run build
Expanded:
> Run command
v Run build
  > build
  > test
  > deploy

Or if there is no Run command task then just

v Run build
  > build
  > test
  > deploy