This is an automated email from the ASF dual-hosted git repository.
kgyrtkirk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hive.git
The following commit(s) were added to refs/heads/master by this push:
new 0099b14aa6a HIVE-25733: Add check-spelling/check-spelling (#2809)
(Josh Soref reviewed by Zoltan Haindrich)
0099b14aa6a is described below
commit 0099b14aa6a50d4470b057e93a95a7391b74add7
Author: Josh Soref <2119212+jso...@users.noreply.github.com>
AuthorDate: Mon Jun 13 11:05:41 2022 -0400
HIVE-25733: Add check-spelling/check-spelling (#2809) (Josh Soref reviewed
by Zoltan Haindrich)
---
.github/actions/spelling/README.md| 17 ++
.github/actions/spelling/advice.md| 25 ++
.github/actions/spelling/allow.txt| 0
.github/actions/spelling/excludes.txt | 57 +
.github/actions/spelling/expect.txt | 449 ++
.github/actions/spelling/only.txt | 1 +
.github/actions/spelling/patterns.txt | 38 +++
.github/actions/spelling/reject.txt | 7 +
.github/workflows/spelling.yml| 69 ++
9 files changed, 663 insertions(+)
diff --git a/.github/actions/spelling/README.md
b/.github/actions/spelling/README.md
new file mode 100644
index 000..749294b33fb
--- /dev/null
+++ b/.github/actions/spelling/README.md
@@ -0,0 +1,17 @@
+# check-spelling/check-spelling configuration
+
+File | Purpose | Format | Info
+-|-|-|-
+
+[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only
letters and `'`s allowed) |
[allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
+[reject.txt](reject.txt) | Remove words from the dictionary (after allow) |
grep pattern matching whole dictionary words |
[reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
+[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular
expression |
[excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
+[only.txt](only.txt) | Only check matching files (applied after excludes) |
perl regular expression |
[only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
+[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl
regular expression (order matters, first match wins) |
[patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
+[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one
word per line (sorted, alphabetically) |
[expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
+[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words
are found | GitHub Markdown |
[advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
+
+Note: you can replace any of these files with a directory by the same name
(minus the suffix)
+and then include multiple files inside that directory (with that suffix) to
merge multiple files together.
diff --git a/.github/actions/spelling/advice.md
b/.github/actions/spelling/advice.md
new file mode 100644
index 000..c83423a8ef6
--- /dev/null
+++ b/.github/actions/spelling/advice.md
@@ -0,0 +1,25 @@
+
+If the flagged items do not appear to be text
+
+If items relate to a ...
+* well-formed pattern.
+
+ If you can write a
[pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns)
that would match it,
+ try adding it to the `patterns.txt` file.
+
+ Patterns are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) 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](
+https://www.regexplanet.com/advanced/perl/) 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](
+../tree/HEAD/README.md) (on whichever branch you're using).
+
+
diff --git a/.github/actions/spelling/allow.txt
b/.github/actions/spelling/allow.txt
new file mode 100644
index 000..e69de29bb2d
diff --git a/.github/actions/spelling/excludes.txt
b/.github/actions/spelling/excludes.txt
new file mode 100644
index 000..f15a0e0c9ca
--- /dev/null
+++ b/.github/actions/spelling/excludes.txt
@@ -0,0 +1,57 @@
+# See
https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
+(?:^|/)(?i)COPYRIGHT
+(?:^|/)(?i)LICEN[CS]E
+(?:^|/)package(?:-lock|)\.json$
+(?:^|/)vendor/
+ignore$
+LICENSE
+\.avi$
+\.avro$
+\.bz2$
+\.deflate$
+\.eot$
+\.gif$
+\.gz$
+\.ico$
+\.jar$
+\.jceks$
+\.jks$
+\.jpe?g$
+\.jpeg$
+\.jpg$
+\.keep$
