Skip to content

Commit

Permalink
Merge pull request #12 from jmuelbert/Update-Github-Actions
Browse files Browse the repository at this point in the history
Update GitHub actions
  • Loading branch information
jmuelbert authored May 4, 2024
2 parents a370aab + 4c3839e commit 84ef0a3
Show file tree
Hide file tree
Showing 160 changed files with 9,917 additions and 712 deletions.
41 changes: 41 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
{
"name": "Python 3",
"image": "mcr.microsoft.com/devcontainers/python:0-3.9",
// See https://containers.dev/features
"features": {
"ghcr.io/devcontainers/features/git:1": {},
"ghcr.io/devcontainers/features/node:1": {},
"ghcr.io/devcontainers-contrib/features/ffmpeg-apt-get:1": {}
},
"hostRequirements": {
"cpus": 4,
"memory": "8gb",
"storage": "32gb"
},
"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"ms-python.vscode-pylance",
"ms-python.black-formatter",
"ms-toolsai.jupiter",
"esbenp.prettier-vscode",
"svelte.svelte-vscode",
"phoenisx.cssvar"
],
"remote.autoForwardPorts": false
}
},
"forwardPorts": [7860, 9876],
"portsAttributes": {
"7860": {
"label": "checkconnect port"
},
"9876": {
"label": "checkconnect dev port"
}
},
"postCreateCommand": "export NODE_OPTIONS=\"--max-old-space-size=8192\" && chmod +x scripts/install_gradio.sh scripts/install_test_requirements.sh scripts/build_frontend.sh && ./scripts/install_gradio.sh && ./scripts/install_test_requirements.sh && ./scripts/build_frontend.sh"
}
21 changes: 21 additions & 0 deletions .fossa.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# Generated by FOSSA CLI (https://github.com/fossas/fossa-cli)
# Visit https://fossa.com to learn more

version: 3
cli:
server: https://app.fossa.com
fetcher: custom
project: https://github.com/jmuelbert/checkconnect
analyze:
modules:
- name: checkconnect
type: pip
- name: docs
type: pip
target: docs
path: docs
- name: .
type: pip
target: .
path: .
133 changes: 133 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
.git* export-ignore
.hooks* export-ignore
.editorconfig export-ignore

# Custom attribute to mark sources as using our C code style.
[attr]our-c-style whitespace=tab-in-indent format.clang-format-6.0

# Custom attribute to mark sources as generated.
# Do not perform whitespace checks. Do not format.
[attr]generated whitespace=-tab-in-indent,-indent-with-non-tab -format.clang-format-6.0

* text=auto !eol svneol=native#text/plain
*.gitattributes text svneol=native#text/plain

# Scriptish formats
*.[1-9] eol=lf
*.bash eol=lf
*.sh eol=lf
*.sh.in eol=lf

*.bat eol=crlf
*.bat.in eol=crlf
*.sln eol=crlf
*.vcproj eol=crlf
*.vcxproj eol=crlf

*.bat text svneol=native#text/plain
*.bsh text svneol=native#text/x-beanshell
*.cgi text svneol=native#text/plain
*.cmd text svneol=native#text/plain
*.js text svneol=native#text/javascript
*.php text svneol=native#text/x-php
*.pl text svneol=native#text/x-perl
*.pm text svneol=native#text/x-perl
*.py text svneol=native#text/x-python
configure eol=lf svneol=LF#text/x-sh

# Image formats
*.bmp binary svneol=unset#image/bmp
*.gif binary svneol=unset#image/gif
*.ico binary svneol=unset#image/ico
*.jpeg binary svneol=unset#image/jpeg
*.jpg binary svneol=unset#image/jpeg
*.png binary svneol=unset#image/png
*.tif binary svneol=unset#image/tiff
*.tiff binary svneol=unset#image/tiff
*.svg text svneol=native#image/svg%2Bxml

# Data formats
*.pdf binary svneol=unset#application/pdf
*.avi binary svneol=unset#video/avi
*.doc binary svneol=unset#application/msword
*.dsp text svneol=crlf#text/plain
*.dsw text svneol=crlf#text/plain
*.eps binary svneol=unset#application/postscript
*.gz binary svneol=unset#application/gzip
*.mov binary svneol=unset#video/quicktime
*.mp3 binary svneol=unset#audio/mpeg
*.ppt binary svneol=unset#application/vnd.ms-powerpoint
*.ps binary svneol=unset#application/postscript
*.psd binary svneol=unset#application/photoshop
*.rdf binary svneol=unset#text/rdf
*.rss text svneol=unset#text/xml
*.rtf binary svneol=unset#text/rtf
*.sln text svneol=native#text/plain
*.swf binary svneol=unset#application/x-shockwave-flash
*.tgz binary svneol=unset#application/gzip
*.vcproj text svneol=native#text/xml
*.vcxproj text svneol=native#text/xml
*.vsprops text svneol=native#text/xml
*.wav binary svneol=unset#audio/wav
*.xls binary svneol=unset#application/vnd.ms-excel
*.zip binary svneol=unset#application/zip

# Text formats
.htaccess text svneol=native#text/plain
*.bbk text svneol=native#text/xml
*.cmake text svneol=native#text/plain
*.css text svneol=native#text/css
*.dtd text svneol=native#text/xml
*.htm text svneol=native#text/html
*.html text svneol=native#text/html
*.ini text svneol=native#text/plain
*.log text svneol=native#text/plain
*.mak text svneol=native#text/plain
*.qbk text svneol=native#text/plain
*.rst text svneol=native#text/plain conflict-marker-size=100
*.sql text svneol=native#text/x-sql
*.txt text svneol=native#text/plain
*.xhtml text svneol=native#text/xhtml%2Bxml
*.xml text svneol=native#text/xml
*.xsd text svneol=native#text/xml
*.xsl text svneol=native#text/xml
*.xslt text svneol=native#text/xml
*.xul text svneol=native#text/xul
*.yml text svneol=native#text/plain
boost-no-inspect text svneol=native#text/plain
CHANGES text svneol=native#text/plain
COPYING text svneol=native#text/plain
INSTALL text svneol=native#text/plain
Jamfile text svneol=native#text/plain
Jamroot text svneol=native#text/plain
Jamfile.v2 text svneol=native#text/plain
Jamrules text svneol=native#text/plain
Makefile* text svneol=native#text/plain
README text svneol=native#text/plain
TODO text svneol=native#text/plain

# Code formats
*.c text svneol=native#text/plain
*.cpp text svneol=native#text/plain
*.h text svneol=native#text/plain
*.hpp text svneol=native#text/plain
*.ipp text svneol=native#text/plain
*.tpp text svneol=native#text/plain
*.jam text svneol=native#text/plain
*.java text svneol=native#text/plain

# Source files
*.ui text
# Fix GitHub thinking our translations are TypeScript
*.ts linguist-language=XML

# Don't count the translation files in the language stats
translations/* linguist-vendored

.tag export-subst
.gitignore export-ignore
.gitattributes export-ignore
.mailmap export-ignore
.tx export-ignore
.LICENSE-HEADER export-ignore
.travis.yml export-ignore
41 changes: 41 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# This file does not signify real code owners. We use it to automate the
# process of assigning code reviews. But generally all members of the
# project own the whole product.


# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
# @global-owner1 @global-owner2

# You can also use email addresses if you prefer. They'll be
# used to look up users just like we do for commit author
# emails.
#.go [email protected]

# The `src/*`pattern will match files like
src/* @jmuelbert

# The `docs/*` pattern will match files like
docs/* @jmuelbert
pages/* @jmuelbert

# Normally, *.ui, *.cpp and *.h files are reviewed by the core-cpp team only
# All files containing UI text are reviewed by the ui-review team
.editorconfig @jmuelbert
.prettierignore @jmuelbert
.prettierrc @jmuelbert
*.conf @jmuelbert
*.json @jmuelbert
*.rb @jmuelbert
*.gemspec @jmuelbert
*.yaml @jmuelbert
*.yml @jmuelbert
*.toml @jmuelbert
Rakefile @jmuelbert
Gemfile @jmuelbert
AUTHORS.md @jmuelbert
CHANGELOG.md @jmuelbert
README.md @jmuelbert
SECURITY.md @jmuelbert
Loading

1 comment on commit 84ef0a3

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (301)
aada
aafc
abbrs
abfb
acefe
actionlint
adrienverge
aeda
aee
aef
AGPL
aiohttp
Aissue
Aktuelle
alessandrojcm
alex
allrepos
alvarez
aminya
andresz
Aopen
apps
arithmatex
asctime
astro
autobuild
autodoc
autofix
autohide
autolabeler
automerge
autorefs
autoupdate
backticks
bbf
bcc
bccc
bdd
bea
behaviorbot
betterem
bfad
bfb
bfbe
bffb
buildscript
ccache
cdc
cdea
ced
cfbbf
charliermarsh
checkbox
checkboxes
checkconnct
checkconnect
checkconnectjs
cla
clangformat
clangtidy
classpath
coc
codacy
codecov
codehilite
codeinclude
codelytv
CODEOWNERS
codeql
codespell
codespellrc
colab
commandline
commitlint
commonmark
compat
conan
configfile
configparser
conventionalcommits
Copyleft
cov
cppcheck
cpr
cssvar
CVS
Datei
dbaeumer
DCMAKE
ddab
debian
debugpy
depandabot
dessant
devcontainer
devguide
devskim
dfa
DFc
differt
dnf
dotnet
DTZ
EAF
ecdcd
edc
edcb
edcd
eeaaad
eecbfbfae
eef
emoji
esbenp
Espa
eupl
facf
factorypath
fbacb
FBT
fcd
fcf
feabb
fef
ffb
ffcb
ffde
fontawesome
fossas
fpdf
fsfe
fwlink
gcc
getattr
getenv
getpreferredencoding
gha
GHE
gitlab
gitleaks
gitlint
glightbox
gmail
gnupg
goodcheck
google
gradio
handover
HORg
htmlcov
hypothesmith
ICN
idstepsrun
igorshubovych
IJyg
img
inlinehilite
INP
Intelli
ipynb
Italiano
Jef
jmuelbert
jmuelbet
jobsjob
joinup
jsonschema
juergen
jupyter
kbd
keepachangelog
keyserver
kwargs
kwds
lbert
levelname
linebreak
linenums
linitig
Liniting
linkid
linting
LJO
localtime
loglevel
lon
magiclink
markdownlint
marocchino
matthiashermsen
mcr
mega
megalinter
microsoft
mkautodoc
mkdocs
mkdocstrings
mozilla
mscadocs
msdo
mshick
muelbert
mxr
mypy
ncipollo
nicolas
NPi
ntp
ntplib
octicons
OOAq
OSL
ossar
ossf
oxsecurity
peaceiris
PGH
phoenisx
Pintaldi
pipx
platformdirs
PLE
plunkr
PLW
progressbar
pydocstyle
pygments
pyguide
PYI
pyinstaller
pylance
pylint
pylintrc
pymdownx
pypa
pypi
pyproject
pytest
PYTHONUNBUFFERED
pyversions
qualname
quickstart
Rakefile
releas
repology
returntocorp
rgba
rhysd
rubocop
RUF
saneheaders
scm
screenshot
semgrep
setuptools
shellcheck
Signup
SLDn
SLF
smartsymbols
snf
Sobolev
sobolevn
socio
sor
squidfunk
srggrs
stackoverflow
standalone
stefanzweifel
styleguide
sublicensable
superfences
svn
swiftlint
taskfile
tasklist
TBC
timezone
toc
tomli
tomwhross
toolsai
twemoji
Unported
until
urllib
utm
venv
versioning
vuillamy
wagoid
website
wikipedia
Wji
wordlist
workflows
writegood
xbps
YTT
zdf
zoneinfo
Some files were automatically ignored 🙈

These sample patterns would exclude them:

(?:^|/)py\.typed$
^\Qcspell.config.yaml\E$
^\Qdocs/guides/configuration.md\E$
^\Qdocs/js/sidecar-1.5.0.js\E$
^\Qdocs/philosophy.md\E$
^\Qdocs/quickstart.md\E$
^\Qdocs/upgrade.md\E$
^\Qproject-words.txt\E$
^\Qsrc/checkconnect/__init__.py\E$
^\Qsrc/checkconnect/config/__init__.py\E$
^\Qsrc/checkconnect/core/__init__.py\E$

You should consider excluding directory paths (e.g. (?:^|/)vendor/), filenames (e.g. (?:^|/)yarn\.lock$), or file extensions (e.g. \.gz$)

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the [email protected]:jmuelbert/checkconnect.git repository
on the main branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/00c989c97749eb0cb2d256bdc55ac61b0096c6d3/apply.pl' |
perl - 'https://github.com/jmuelbert/checkconnect/actions/runs/8949913259/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:python/src/python/python.txt 392 16 8
cspell:python/src/common/extra.txt 741 5 4
cspell:php/dict/php.txt 1689 9 3
cspell:aws/aws.txt 218 6 3
cspell:fullstack/dict/fullstack.txt 419 6 3

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@00c989c97749eb0cb2d256bdc55ac61b0096c6d3 in its with:

      with:
        extra_dictionaries:
          cspell:python/src/python/python.txt
          cspell:python/src/common/extra.txt
          cspell:php/dict/php.txt
          cspell:aws/aws.txt
          cspell:fullstack/dict/fullstack.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@00c989c97749eb0cb2d256bdc55ac61b0096c6d3 in its with:

check_extra_dictionaries: ''
Pattern suggestions ✂️ (22)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 152 file-count: 34
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]

# hit-count: 65 file-count: 28
# hex runs
\b[0-9a-fA-F]{16,}\b

# hit-count: 61 file-count: 22
# Non-English
[a-zA-Z]*[ÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*|[a-zA-Z]{3,}[ÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]|[ÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3,}

# hit-count: 50 file-count: 16
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)

# hit-count: 12 file-count: 2
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*

# hit-count: 11 file-count: 1
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|[iu]\d+)\b

# hit-count: 7 file-count: 1
# base64 encoded content, possibly wrapped in mime
(?:^|[\s=;:?])[-a-zA-Z=;:/0-9+]{50,}(?:[\s=;:?]|$)

# hit-count: 5 file-count: 3
# URL escaped characters
\%[0-9A-F][A-F]

# hit-count: 3 file-count: 1
# css url wrappings
\burl\([^)]+\)

# hit-count: 3 file-count: 1
# data url in parens
\(data:(?:[^) ][^)]*?|)(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})[^)]*\)

# hit-count: 2 file-count: 2
# mailto urls
mailto:[-a-zA-Z=;:/?%&0-9+@.]{3,}

# hit-count: 2 file-count: 2
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*

# hit-count: 2 file-count: 2
# Twitter status
\btwitter\.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)

# hit-count: 2 file-count: 1
# data url
data:[-a-zA-Z=;:/0-9+]*,\S*

# hit-count: 2 file-count: 1
# node packages
(["'])\@[^/'" ]+/[^/'" ]+\g{-1}

# hit-count: 2 file-count: 1
# Compiler flags (Unix, Java/Scala)
# Use if you have things like `-Pdocker` and want to treat them as `docker`
(?:^|[\t ,>"'`=(])-(?:(?:J-|)[DPWXY]|[Llf])(?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})

# hit-count: 2 file-count: 1
# Compiler flags (Windows / PowerShell)
# This is a subset of the more general compiler flags pattern.
# It avoids matching `-Path` to prevent it from being treated as `ath`
(?:^|[\t ,"'`=(])-(?:[DPL](?=[A-Z]{2,})|[WXYlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}))

# hit-count: 1 file-count: 1
# The leading `/` here is as opposed to the `\b` above
# ... a short way to match `https://` or `http://` since most urls have one of those prefixes
# Google Docs
/docs\.google\.com/[a-z]+/(?:ccc\?key=\w+|(?:u/\d+|d/(?:e/|)[0-9a-zA-Z_-]+/)?(?:edit\?[-\w=#.]*|/\?[\w=&]*|))

# hit-count: 1 file-count: 1
# Google Groups
\bgroups\.google\.com(?:/[a-z]+/(?:#!|)[^/\s"]+)*

# hit-count: 1 file-count: 1
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)

# hit-count: 1 file-count: 1
# stackexchange -- https://stackexchange.com/feeds/sites
\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/)

# hit-count: 1 file-count: 1
# curl arguments
\b(?:\\n|)curl(?:\s+-[a-zA-Z]{1,2}\b)*(?:\s+-[a-zA-Z]{3,})(?:\s+-[a-zA-Z]+)*

Errors (6)

See the 📜action log or 📝 job summary for details.

❌ Errors Count
ℹ️ binary-file 8
ℹ️ candidate-pattern 36
❌ check-file-path 67
❌ dictionary-not-found 6
❌ forbidden-pattern 7
ℹ️ noisy-file 4

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    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).

  • 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.

🚂 If you're seeing this message and your PR is from a
branch that doesn't have check-spelling, please merge to your PR's base
branch to get the version configured for your repository.

Please sign in to comment.