build(deps): bump check-spelling/check-spelling from 0.0.19 to 0.0.21

[dependabot]

Bumps check-spelling/check-spelling from 0.0.19 to 0.0.21.

Release notes

Sourced from check-spelling/check-spelling's releases.

Release 0.0.21

⏩ Upgrading

• 🏷️ You can just change your workflow tags/references to this release, but some features require updates to the workflow (including sarif output and binary file detection); please consider applying the workflow from check-spelling/spell-check-this@prerelease. (The link will change shortly after this release is made.)
  • You will want to copy over the with: elements you're using (into each place that uses: check-spelling/check-spelling).

🐣 Breaking Changes

🗜️ Smaller cspell dictionaries

Background

There are 3 related configuration items:

• dictionary_source_prefixes
  • In v0.0.20, this had: "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220427/dictionaries/"
  • In v0.0.21, it has: "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/"
• extra_dictionaries
• check_extra_dictionaries
  • The list has changed between v0.0.20 and v0.0.21, a bunch have moved, some have split, and a bunch have been added.

Migrating

You can migrate in a couple of ways:

• Assuming you haven't set dictionary_source_prefixes, you can temporarily clear extra_dictionaries and check_extra_dictionaries and then use one run to get a new set of recommended extra_dictionaries and then set check_extra_dictionaries (typically to '').
• If you want to keep your current cspell extra_dictionaries, change cspell to cspell_old (or anything that isn't cspell) and set dictionary_source_prefixes to something like this: {"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/", "cspell_old": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220427/dictionaries/"}.

Note that the main branch for check-spelling/cspell-dicts will move (roughly at the time of the v0.0.21 release and again for future releases).

🧗 act

Some changes in how the action works require actions/download-artifact and actions/upload-artifact which aren't generally supported by act. It might be possible to use --artifact-server-path, but I don't know how to do it.

Mitigation

You can apply changes equivalent to the changes to .github/workflows/spelling.yml to your workflow. This should enable the act workflows to conspire to share data between jobs. Alternatively, you could remove post_comment: 0 from your spelling job. And that should result in a report.

The log will include a base64 encoded zip file along with instructions to decode it and a command that will let you feed the file to apply.pl to apply its suggestions.

🏛️ Behavior change: File line column notation

Log output will now use a format like .github/workflows/spelling.yml:54:9 ... 21 to report problems. This should be friendlier to automated tools. Anyone who had written their own code to parse the old format will need to adjust their tooling. I don't expect this to be a big concern.

✨ New features

• 📰 Step Summary
• 🌟 Sarif output
• 🧙 Suggest patterns
• 🏗️ Update expect command-line this should add support for 🪟 Windows!
• 🔍 Check commit messages
• 🪖 Restricted Permissions
• 🧃 Minified file detection

... (truncated)

Commits

• d7cd297 Release 0.0.21
• 388a389 Refactor wrap_in_json / wrap_file_in_json
• df9612f Ignore files with newlines in their names
• 91d4beb Quote things
• 312d342 Handle act 0.2.33 github.action_repository behavior
• e6a8467 Handle act 0.2.33 GITHUB_JOB behavior
• fcf8407 Expose artifact.zip to act
• a205652 Handle malformed GITHUB_REPOSITORY
• e782d89 Trap missing $counter_summary_file
• 44cf90d Use emoji near Previously acknowledged for email
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[github-actions]

@check-spelling-bot Report

Unrecognized words, please review:

• builddeb

Previously acknowledged words that are now absent

AUTHIP CIDR NOTAUTH pieter weightparams

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]:jsoref/pdns.git repository
on the dependabot/github_actions/check-spelling/check-spelling-0.0.21 branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spell-check/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/spell-check/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/jsoref/pdns/issues/comments/1329986133" > "$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

If the flagged items do not appear to be text

If items relate to a ...

• well-formed pattern.

  If you can write a pattern that would match it,
  try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

• binary file.

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

[dependabot]

Looks like check-spelling/check-spelling is up-to-date now, so this is no longer needed.