Display InstallationNotes after a successful install

[ryfu-msft]

Resolves #607

• Adds support for displaying the installation notes after a successful installation
• Adds the --display-notes flag and the --suppress-notes flag to control the default behavior of displaying the install notes
• Adds the setting suppressInstallNotes which is set to false by default
• Adds a unit test to verify that installationNotes are displayed when the --display-notes flag is present

Microsoft Reviewers: Open in CodeFlow

[github-actions]

@check-spelling-bot Report

Unrecognized words, please review:

• Showss

Previously acknowledged words that are now absent

activatable amd Archs dsc enr FWW Globals hackathon lww mytool OSVERSION Packagedx parametermap symlink Uninitialize WDAG whatif wsb

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the [email protected]:ryfu-msft/winget-cli.git repository
on the installationNotes branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/winget-cli/issues/comments/1144122409" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

[JohnMcPMS]

We should consider if show should also display the notes. I feel like it probably should. Has this already been discussed @denelon?

[ryfu-msft]

We should consider if show should also display the notes. I feel like it probably should. Has this already been discussed @denelon?

Hasn't been discussed yet, but I agree with this. Added functionality to display installationNotes for show command

[denelon]

We should consider if show should also display the notes. I feel like it probably should. Has this already been discussed @denelon

Hasn't been discussed yet, but I agree with this. Added functionality to display installationNotes for show command

Yes, this should be added.