Skip to content

Produce readable note field in appstudio output#963

Merged
simonbaird merged 1 commit into
conforma:mainfrom
simonbaird:appstudio-conftest-output-note-field
Aug 24, 2023
Merged

Produce readable note field in appstudio output#963
simonbaird merged 1 commit into
conforma:mainfrom
simonbaird:appstudio-conftest-output-note-field

Conversation

@simonbaird

@simonbaird simonbaird commented Aug 23, 2023

Copy link
Copy Markdown
Member

The appstudio output format includes a note field, which prior to this patch was not populated at all unless there was an error. Let's put at least something in that field.

Notes:

  • I did consider putting an abbreviated version of the actual failure or warning messages into the note. I think it would be possible, but it's not simple so I decided not to do it here.
  • There seems to be a usability issue with this. If we output only the appstudio summary, then the failure messages and descriptions are not visible anywhere. There are probabaly some ways to get around that, but let's not try to anticipate what the requirements are.

The appstudio output format includes a note field, which prior to
this patch was not populated at all unless there was an error. Let's
put at least something in that field.

Notes:
- I did consider putting an abbreviated verison of the actual failure
  or warning messges into the note. I think it would be possible, but
  it's not simple so I decided not to do it here.
- There seems to be a usability issue with this. If we output only the
  appstudio summary, then the failure messages and descriptions are not
  visible anywhere. There are probabaly some ways to get around that,
  but let's not try to anticipate what the requirements are.
@codecov

codecov Bot commented Aug 23, 2023

Copy link
Copy Markdown

Codecov Report

Merging #963 (39d7869) into main (532396f) will increase coverage by 5.38%.
The diff coverage is 0.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #963      +/-   ##
==========================================
+ Coverage   80.04%   85.42%   +5.38%     
==========================================
  Files          57       64       +7     
  Lines        4841     5188     +347     
==========================================
+ Hits         3875     4432     +557     
+ Misses        966      756     -210     
Flag Coverage Δ
acceptance 69.21% <0.00%> (?)
generative 51.77% <0.00%> (-0.35%) ⬇️
integration 62.34% <0.00%> (-0.34%) ⬇️
unit 71.53% <0.00%> (-0.15%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
cmd/test/appstudio.go 35.55% <0.00%> (ø)
internal/applicationsnapshot/report.go 85.53% <0.00%> (+7.68%) ⬆️

... and 29 files with indirect coverage changes

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.

2 participants