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

Workflow command support for MATLAB Build results #32

Merged
merged 80 commits into from
May 20, 2024
Merged

Conversation

nbhoski
Copy link
Contributor

@nbhoski nbhoski commented May 15, 2024

This PR integrates the GitHub Workflow commands in actions logs to improve the accesibility of the build log. The changes are as below

  • Added::group:: workflow command for each task
  • This will encapsulate each task in the colapsable group
  • Each task is now postfixed with <task_Name> - task to maintain better hierarchy
  • Now the run-build task shows Running MATLAB Build as header and all the build activities are are listed under the same hierarchy
  • Extra groups like Script generation messages are been removed now to declutter the build section.
  • Errors are embedded in the groups too and ::error:: command is added for failed task
  • Error is directly annotated in the summary page, Which enables the user to navigate to the error line directly by clicking on it.
  • Tests are updated, currently log accessing is bit challenging hence tests are not included to verify text present in log

Screenshots

image

image

image

image

Copy link
Member

@acampbel acampbel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for putting this forth Nikhil. Can we have a "naming pass" of sorts for the format of the task section headers. For example, what are the different options we are considering, a small list of possibilities, where task is the task name:

  1. {task} - task (what this PR shows)
  2. Task: {task}
  3. Task - {task}
  4. MATLAB Build - {task}
  5. {task}
  6. etc

.github/workflows/bat.yml Outdated Show resolved Hide resolved
scripts/setupdeps.sh Outdated Show resolved Hide resolved
plugins/+ciplugins/+github/WorkflowCommandsPlugin.m Outdated Show resolved Hide resolved
plugins/+ciplugins/+github/WorkflowCommandsPlugin.m Outdated Show resolved Hide resolved
@nbhoski nbhoski requested a review from davidbuzinski May 16, 2024 16:00
src/buildtool.ts Outdated Show resolved Hide resolved
@nbhoski nbhoski requested review from mcafaro and acampbel May 17, 2024 19:31
src/index.ts Outdated Show resolved Hide resolved
@nbhoski nbhoski requested a review from mcafaro May 20, 2024 06:42
src/buildtool.unit.test.ts Outdated Show resolved Hide resolved
src/index.ts Outdated Show resolved Hide resolved
@nbhoski nbhoski merged commit ae4bdd2 into main May 20, 2024
1 check passed
@nbhoski nbhoski deleted the workflow_command branch May 20, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants