Skip to content

Commit

Permalink
0.0.21.alpha1 prerelease
Browse files Browse the repository at this point in the history
This is a short term release. I expect to remove this tag at some point after
I cut the next release.

The commits between 0.0.20 on main and this commit are likely to be rewritten,
as this is not a finalized changeset.

I may drop features between now and the next release, but this is quite unlikely.

I expect to leave this release up for some period after the next official
release.

Note that the workflow has had some significant changes since previous versions,
so you will probably want to refresh it based on:
https://github.com/check-spelling/spell-check-this/blob/9673a4c799e352a38a65ae9d2e92595445f96353/.github/workflows/spelling.yml

Especially splitting the comment-pr / comment-push.

The individual with flags are things you should choose individually.

[`use_magic_file`](https://github.com/check-spelling/check-spelling/wiki/Configuration#use_magic_file)
Is a brand new feature. I'm definitely looking for feedback -- if it
complains about a file and you think it shouldn't, I'd like to know.
So far, it has only complained about one interesting file (it found a
0x7f in a .go file). The project wasn't [attached](facebook/time@6266b73)
to that byte...

[`check_commit_messages`](https://github.com/check-spelling/check-spelling/wiki/Configuration#check_commit_messages)
is something I'm still experimenting with. I don't expect most projects
will want to use it.

[`check_file_names`](https://github.com/check-spelling/check-spelling/wiki/Configuration#check_file_names)
has been available for a bit, but I've only started using it myself
recently. I don't know if projects will want to use it, you should
consider whether it's valuable for your project. I think in general,
the cost to using it shouldn't be particularly burdensome as it'll just
result in a couple of items that your users add to `expect.txt`, and
most of the time the file names or paths should correspond to content
that's already being checked.

[`use_sarif`](https://github.com/check-spelling/check-spelling/wiki/Configuration#use_sarif)
is a brand new feature.  I'm definitely looking for feedback.

GitHub's handling of SARIF content is somewhat quirky. If you have the
resources to complain to GitHub about its handling, that's appreciated.

If you find bugs in the generated sarif, please report them.

Note: this is the second release where I intend to use the ability to report
on the status of a release after it is made.

For more information, see:
https://github.com/check-spelling/check-spelling/wiki/Feature:-Security-Polling
  • Loading branch information
jsoref committed Nov 25, 2022
1 parent cd3ce4d commit c563aa9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion version
@@ -1 +1 @@
0.0.20
0.0.21.alpha1

0 comments on commit c563aa9

Please sign in to comment.