updates

Author: Lng88

.github/workflows/main.yml

@@ -93,5 +93,7 @@ jobs:
         with:
           file: Dockerfile.gl
           push: true
-          tags: ghcr.io/splunk/biased_lang_gitlab:test
+          tags: |
+            ghcr.io/splunk/biased_lang_gitlab:test
+            ghcr.io/splunk/biased_lang_gitlab:1.0.0
 #TODO: Find way to test GitLab side of things

README.md

@@ -1,6 +1,6 @@
 # Description
 
-This is a code linter that checks for biased language in a code repository.
+This is a code linter that checks for biased language in a code repository. Currently the words we are searching for are listed in `word_list.csv`. 
 
 1. [Quickstart](#quickstart)
 2. [Developer Instructions](#developer-instructions)
@@ -68,24 +68,22 @@ Follow these instructions to set up Biased Lang Linter locally for development.
 ### Required Dependencies
 
 - python 3.7+
-- ripgrep (Installation instructions [here](https://github.com/BurntSushi/ripgrep#installation). On MacOS, `brew install ripgrep`.)
-
-### JSON output
-
-**JSON output:** `run_json.py` outputs formatted JSON summaries, can send results to Splunk, and has additional options that are helpful for GitLab CI pipelines.
+- ripgrep (Installation instructions [here](https://github.com/BurntSushi/ripgrep#installation).
 
 ### More on [args]
 
-Unless otherwise noted, all arguments are available for both JSON and standard output. Required arguments: `--path` and `--mode`.
+Below is a list of arguments you can pass to the CLI tool.
+Note: For the additional arguments you find in `run_json.py` that aren't listed below, they are for internal use.
 
 - **`--path=`** [_**required**_] absolute path to the directory
 - **`--mode=`** [_**required**_] `check` to scan for bias language
 - **`--verbose`** enables explicit logging (only applicable for check mode)
 - **`--err_file=`** sends any error messages to a log file of your choice, in addition to the console
-- **`--splunk`** not available yet (Splunk instance required)
-- **`--splunk_token=`** not available yet (Splunk instance required)
-- **`--url=`** not available yet (Splunk instance required)
-- **`--github_repo=`** not available yet (Splunk instance required)
+- **`--splunk`** [_**splunk_required**_] not available yet
+- **`--splunk_token=`** [_**splunk_required**_] not available yet
+- **`--url=`** [_**splunk_required**_] the project url. This will be the `sourcetype` in Splunk.
+- **`--github_repo=`** [_**github_only**_] the repository path for repo's run in GitHub Actions. Also acts as a flag to confirm GitHub environment
+
 
 ### Usage Example
 
@@ -139,15 +137,7 @@ python3 run_json.py --mode=check --path=/user/jdoe/git/myProject
 
 ## Formatting of word_list.csv
 
-When running, `1 to 1` option the `biasedWord` will be directly replaced by the `allowedWord` if `--mode=fix` (Currently not availble).
-When running with many options it won't replace automatically, but it shows your provided options for your context.
-
-```sh
-# 1 to many options
-biasedWord,"option1,option2"
-# 1 to 1 option
-biasedWord,allowedWord
-```
+The biased words are listed on a new line. If you would like to propose a new biased word, we will need to 
 
 ## Excluding directories and files
 
@@ -170,3 +160,7 @@ If the pipeline detects biased language anywhere in the repository, the `biased_
 **Q: I'm including git submodules in my repo and seems to be breaking the workflow, what can I do?**
 
 **A:** You'll need to add your submodule paths in the `.biased_lang_exclude` file. You can find info on how to (exclude files and directories here)[#excluding-directories-and-files]
+
+## Learn More
+
+- Write Unbiased Documentation: [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Inclusivity)

run_json.py

@@ -48,7 +48,6 @@ def build_args_dict(args=None):
     parser.add_argument('--path')
     parser.add_argument('--url')
     parser.add_argument('--mode')
-    parser.add_argument('--splunk_logs', action='store_true')
     parser.add_argument('--verbose', action='store_true')
     parser.add_argument('--err_file')
     parser.add_argument('--splunk', action='store_true')
@@ -87,7 +86,6 @@ def build_args_dict(args=None):
         'mode': mode,
         'is_verbose': args.verbose,
         'splunk_flag': args.splunk,
-        'enable_logs': args.splunk_logs,
         'err_file': args.err_file,
         'h_endpoint': args.h_endpoint,
         'splunk_token': args.splunk_token,

tests/unit/test_unit.py

@@ -68,7 +68,7 @@ def test_open_csv():
     data = open_csv('word_list.csv')
     assert len(data) == 4
     for w in data:
-        assert len(w) == 2
+        assert len(w) == 1
 
 
 def test_write_file():
@@ -115,7 +115,7 @@ def test_build_args_dict():
     assert args['path'] == mock_repo_path
     assert args['mode'] == 'check'
     assert args['err_file'] == constants.ERR_FILE
-    assert len(args) == 12
+    assert len(args) == 11
 
 
 def test_process_word_occurrences(batch_info):

word_list.csv

@@ -1,4 +1,4 @@
-master,"main,primary"
-blacklist,blocklist
-whitelist,allowlist
-slave,worker
+master
+blacklist
+whitelist
+slave