diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json index 8e45eac..6acad49 100644 --- a/.github/linters/.jscpd.json +++ b/.github/linters/.jscpd.json @@ -1,3 +1,3 @@ { "threshold": 13 -} \ No newline at end of file +} diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index aec8fd5..40ed110 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.github/linters/.markdown-lint.yml @@ -1,3 +1 @@ -{ - "line-length": false -} +{ "line-length": false } diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml new file mode 100644 index 0000000..c05c231 --- /dev/null +++ b/.github/workflows/spellcheck.yaml @@ -0,0 +1,19 @@ +name: spellcheck + +on: + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - uses: streetsidesoftware/cspell-action@v7 + with: + config: .vscode/cspell.json diff --git a/.gitignore b/.gitignore index be87117..d411341 100644 --- a/.gitignore +++ b/.gitignore @@ -128,4 +128,8 @@ dmypy.json # Pyre type checker .pyre/ +# Visual Studio code +.vscode/* +!.vscode/cspell.json +*.code-workspace .history diff --git a/.vscode/cspell.json b/.vscode/cspell.json new file mode 100644 index 0000000..7cc09aa --- /dev/null +++ b/.vscode/cspell.json @@ -0,0 +1,41 @@ +{ + "version": "0.2", + "language": "en", + "words": [ + "amazonlinux", + "aptdownloader", + "arawinters", + "barrycaceres", + "CCLA", + "CODEOWNER", + "compressedfile", + "configmgr", + "configtables", + "configtool", + "configurator", + "createproject", + "dockerfiles", + "dockerhub", + "docktermj", + "dumpstack", + "gapper", + "gdev", + "ibmcom", + "ICLA", + "iniparams", + "kernelsam", + "mypy", + "pydev", + "pylint", + "redoer", + "Senzing", + "senzingapi", + "setupconfig", + "signingkey", + "stackoverflow", + "strerror", + "updateproject", + "venv" + ], + "ignorePaths": [".git/**", ".gitignore", ".mypy_cache/**", ".venv/**"] +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 53ffc7a..deb0bd2 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2aafff8..84f7b2b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,9 +14,9 @@ There are a number of ways you can contribute: ## License Agreements -If your contribution modifies the git repository, the following agreements must be established. +If your contribution modifies the Git repository, the following agreements must be established. -*Note:* License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository. +_Note:_ License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository. In simple terms, license agreements are needed before pull requests can be accepted. A license agreement is not needed for submitting feature request, bug reporting, or other project management. diff --git a/examples/add-labels-standardized/README.md b/examples/add-labels-standardized/README.md index 5c7cf75..46c9302 100644 --- a/examples/add-labels-standardized/README.md +++ b/examples/add-labels-standardized/README.md @@ -1,31 +1,31 @@ -# Update git action file +# Update Git action file ## Prerequisites 1. Set these environment variable values: - ```console - export GIT_ACCOUNT=senzing - export GIT_REPOSITORY=github-util - export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git - export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" - ``` + ```console + export GIT_ACCOUNT=senzing + export GIT_REPOSITORY=github-util + export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git + export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" + ``` 1. :pencil2: Set `GITHUB_ACCESS_TOKEN`. This is needed to access GitHub above the "public" limit. For information on how to obtain an access token, see [Creating a personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token). - ```console - export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - ``` + ```console + export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + ``` ## add-labels-standardized.sh 1. Run `add-labels-standardized.sh`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-labels-standardized - ./add-labels-standardized.sh - ``` + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-labels-standardized + ./add-labels-standardized.sh + ``` diff --git a/examples/add-to-project/README.md b/examples/add-to-project/README.md index d14e547..52d44a2 100644 --- a/examples/add-to-project/README.md +++ b/examples/add-to-project/README.md @@ -1,99 +1,99 @@ -# Update git action file +# Update Git action file ## Prerequisites 1. Set these environment variable values: - ```console - export GIT_ACCOUNT= - export GIT_REPOSITORY=github-util - export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git - export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" - ``` + ```console + export GIT_ACCOUNT= + export GIT_REPOSITORY=github-util + export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git + export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" + ``` - - Where `GITHUB_ORG` is one of `senzing`, `senzing-garage`, or `senzing-factory` + - Where `GITHUB_ORG` is one of `senzing`, `senzing-garage`, or `senzing-factory` 1. :pencil2: Set `GITHUB_ACCESS_TOKEN`. This is needed to access GitHub above the "public" limit. For information on how to obtain an access token, see [Creating a personal access token]. - ```console - export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - ``` + ```console + export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + ``` ## add-to-project.sh 1. Run `add-to-project.sh` for `senzing-app-server`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-to-project + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-to-project - export SENZING_TOPICS_INCLUDED=senzing-app-server - export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-app-server.yaml + export SENZING_TOPICS_INCLUDED=senzing-app-server + export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-app-server.yaml - ./add-to-project.sh - ``` + ./add-to-project.sh + ``` 1. Run `add-to-project.sh` for `senzing-community`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-to-project + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-to-project - export SENZING_TOPICS_INCLUDED=senzing-community - export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-community.yaml + export SENZING_TOPICS_INCLUDED=senzing-community + export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-community.yaml - ./add-to-project.sh - ``` + ./add-to-project.sh + ``` 1. Run `add-to-project.sh` for `senzing-garage`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-to-project + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-to-project - export SENZING_TOPICS_INCLUDED=senzing-garage - export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-garage.yaml + export SENZING_TOPICS_INCLUDED=senzing-garage + export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-garage.yaml - ./add-to-project.sh - ``` + ./add-to-project.sh + ``` 1. Run `add-to-project.sh` for `senzing-g2-python`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-to-project + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-to-project - export SENZING_TOPICS_INCLUDED=senzing-g2-python - export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-g2-python.yaml + export SENZING_TOPICS_INCLUDED=senzing-g2-python + export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-g2-python.yaml - ./add-to-project.sh - ``` + ./add-to-project.sh + ``` 1. Run `add-to-project.sh` for `senzing-gdev`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-to-project + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-to-project - export SENZING_TOPICS_INCLUDED=senzing-gdev - export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-gdev.yaml + export SENZING_TOPICS_INCLUDED=senzing-gdev + export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-gdev.yaml - ./add-to-project.sh - ``` + ./add-to-project.sh + ``` 1. Run `add-to-project.sh` for `senzing-factory`. Example: - ```console - cd ${GIT_REPOSITORY_DIR}/examples/add-to-project + ```console + cd ${GIT_REPOSITORY_DIR}/examples/add-to-project - export SENZING_TOPICS_INCLUDED=senzing-factory - export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-factory.yaml + export SENZING_TOPICS_INCLUDED=senzing-factory + export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-factory.yaml - ./add-to-project.sh - ``` + ./add-to-project.sh + ``` [Creating a personal access token]: https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token diff --git a/examples/repository-teams/README.md b/examples/repository-teams/README.md index dbdc10e..a90b110 100644 --- a/examples/repository-teams/README.md +++ b/examples/repository-teams/README.md @@ -4,87 +4,87 @@ 1. Set these environment variable values: - ```console - export GIT_ACCOUNT= - export GIT_REPOSITORY=github-util - export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git - export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" - ``` + ```console + export GIT_ACCOUNT= + export GIT_REPOSITORY=github-util + export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git + export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}" + ``` - - Where `GITHUB_ORG` is one of `senzing`, `senzing-garage`, or `senzing-factory` + - Where `GITHUB_ORG` is one of `senzing`, `senzing-garage`, or `senzing-factory` 1. :pencil2: Set `GITHUB_ACCESS_TOKEN`. This is needed to access GitHub above the "public" limit. For information on how to obtain an access token, see [Creating a personal access token]. - ```console - export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - ``` + ```console + export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + ``` ## Find repositories assigned to a team 1. Repositories assigned to `senzing-app-server`. Example: - ```console - cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names --topics-include=senzing-app-server - ``` + ```console + cd ${GIT_REPOSITORY_DIR} + ./github-util.py print-repository-names --topics-include=senzing-app-server + ``` 1. Repositories assigned to `senzing-community`. Example: - ```console - cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names --topics-include=senzing-community - ``` + ```console + cd ${GIT_REPOSITORY_DIR} + ./github-util.py print-repository-names --topics-include=senzing-community + ``` 1. Repositories assigned to `senzing-g2-python`. Example: - ```console - cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names --topics-include=senzing-g2-python - ``` + ```console + cd ${GIT_REPOSITORY_DIR} + ./github-util.py print-repository-names --topics-include=senzing-g2-python + ``` 1. Repositories assigned to `senzing-garage`. Example: - ```console - cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names --topics-include=senzing-garage - ``` + ```console + cd ${GIT_REPOSITORY_DIR} + ./github-util.py print-repository-names --topics-include=senzing-garage + ``` 1. Repositories assigned to `senzing-gdev`. Example: - ```console - cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names --topics-include=senzing-gdev - ``` + ```console + cd ${GIT_REPOSITORY_DIR} + ./github-util.py print-repository-names --topics-include=senzing-gdev + ``` 1. Repositories assigned to `senzing-factory`. Example: - ```console - cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names --topics-include=senzing-factory - ``` + ```console + cd ${GIT_REPOSITORY_DIR} + ./github-util.py print-repository-names --topics-include=senzing-factory + ``` ## Find repositories that aren't assigned to a team -Currently there are 4 teams identified by GitHub topics: `senzing-app-server`, `senzing-community`, `senzing-g2-python`, `senzing-garage`, `senzing-gdev`, `senzing-factory`. +Currently there are 4 teams identified by GitHub topics: `senzing-app-server`, `senzing-community`, `senzing-g2-python`, `senzing-garage`, `senzing-gdev`, `senzing-factory`. 1. List any repositories that do not belong to a team and are not deprecated/archived/obsolete. Example: - ```console - cd ${GIT_REPOSITORY_DIR} + ```console + cd ${GIT_REPOSITORY_DIR} - ./github-util.py print-repository-names \ - --topics-not-any=senzing-community,senzing-app-server,senzing-g2-python,senzing-garage,senzing-gdev,senzing-factory \ - --topics-exclude=archived,deprecated,obsolete - ``` + ./github-util.py print-repository-names \ + --topics-not-any=senzing-community,senzing-app-server,senzing-g2-python,senzing-garage,senzing-gdev,senzing-factory \ + --topics-exclude=archived,deprecated,obsolete + ``` [Creating a personal access token]: https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token