4 | GitHub Status Badge Pathfinding

[ReedClanton]

Description of Changes

Split up runs of unit tests that include profiling and code coverage calculation out into a separate workflow that's not run as often. This speeds up the workflow that's run more often.

Reduced what gets run when so the pipeline takes less time. For example, if you touch some code, the the pipeline for that portion of code will run, but not the entire pipeline.

Fixed some style guide issues after adding style guide checks to more of the code base. Note that the backUp() function doesn't pass the style guide check. I may end up removing the check if I can't get it to pass and writing a GitHub issue to cover the work.

Finally, I added badges to tell a user looking at the documentation if the code runs on the shell they are using.

The Basics

These should be checked immediately upon PR (Peer Review) creation:

• The name of the branch is:
  • <feature/bug>/<issueId>-<issue-title-with-dashes-between-and-no-capitalization>
• The title of this PR is:
  • <issueId> | <Issue Title>
• Changes are being merged into the correct branch (normally main).
• PR has been assigned to you.
• Labels have been filled out:
  • Normally, they reflect the labels of the issue the PR is for, but verify this, and if different, update the issue's labels.
• Description of Changes section has been filled out.
• @ReedClanton has been added as a reviewer.
• PR has been marked as Draft when not ready for review.

Check Before Moving Out of Draft

• For the GitHub issue associated with this work:
  • Everything from the Details section has been addressed.
  • All artifact(s) listed in the Artifact(s) section exist.
  • The Scope section has been adhered to:
    • If not, provide a justification for this in the Description of Changes section.
  • Checked for new GitHub issue comments and addressed.
  • Verified existing GitHub issue comments have been addressed.
• All code changes, including unit tests:
  • Adhere to the style guide:
    • Code style guide is located in the Shell Style Guide section of README.md at the root of the project.
    • Test style guide is located in the README.md at the root of the unit testing directory.
  • Executes successfully locally.
  • Style checker executes successfully by the GitHub runner (pipeline).
• Documentation:
  • README.md of all code touched, including unit tests:
    • Has been read to asses what additions and updates should be made.
    • Has been updated.
  • Script/Function/Help doc of all code touched (if you touch the file, you own all documentation updates):
    • Has been read to asses what additions and updates should be made.
    • Has been updated.
• Testing:
  • New code:
    • Has 100% Unit test coverage (other than main.sh files).
    • Is run by a GitHub workflow (the pipeline).
    • Runs successfully by GitHub runner (the pipeline).
    • New unit tests are being run by GitHub actions (pipeline).
    • New code's dependency tree has been added to <repoRoot>/.github/badge-dependencies.
  • Coverage:
    • Unit test coverage of all code touched has not dropped.
    • 100% coverage exists for all added code.
    • Checked if unit test coverage has increased, if so:
      • Update GitHub workflows .yml files that run the unit tests in the pipeline to increase the minimum coverage level required for pipeline success.
      • Important:
        • Until Determine Why --fail-low-coverage ShellSpec Option *Always* Causes Pipeline Failure #20 is worked, pipeline doesn't enforce failure due to lack of code coverage!
  • All tests (unit, functional, or otherwise) run successfully:
    • By GitHub runner (the pipeline).
    • Locally.
  • If new environment variable(s) were added:
    • Environment variables are unset by the spec_helper_precheck() function in <repoRoot>/spec/spec_helper.sh.
    • All unit tests of the code that uses them set or unset them at the top or within the test.
    • 100% Unit test coverage of environment variable(s).

Check Before Each Push

• For the GitHub issue associated with this work:
  • The Scope section is being adhered to.
• Documentation:
  • README.md of all code touched, including unit tests:
    • Has been read to asses what additions and updates should be made.
    • Has been updated.
  • Script/Function/Help doc of all code touched (if you touch the file, you own all documentation updates):
    • Has been read to asses what additions and updates should be made.
    • Has been updated.
• Testing:
  • New code:
    • Has 100% Unit test coverage (other than main.sh files).
    • Is run by a GitHub workflow (the pipeline).
    • Runs successfully by GitHub runner (the pipeline).
    • New unit tests are being run by GitHub actions (pipeline).
  • Coverage:
    • Unit test coverage of all code touched has not dropped.
    • 100% coverage exists for all added code.
    • Checked if unit test coverage has increased, if so:
      • Update GitHub workflows .yml files that run the unit tests in the pipeline to increase the minimum coverage level required for pipeline success.
  • All tests (unit, functional, or otherwise) run successfully:
    • By GitHub runner (the pipeline).
    • Locally.
  • If new environment variable(s) were added:
    • Environment variables are unset by the spec_helper_precheck() function in <repoRoot>/spec/spec_helper.sh.
    • All unit tests of the code that uses them set or unset them at the top or within the test.
    • 100% Unit test coverage of environment variable(s).

Check After Final Push

• For the GitHub issue associated with this work:
  • Everything from the Details section has been addressed.
  • All artifact(s) listed in the Artifact(s) section exist.
  • The Scope section has been adhered to:
    • If not, provide a justification for this in the Description of Changes section.
  • Checked for new GitHub issue comments and addressed.
  • Verified existing GitHub issue comments have been addressed.
• All code changes, including unit tests:
  • Adhere to the style guide:
    • Code style guide is located in the README.md at the root of the repository.
    • Test style guide is located in the README.md at the root of the unit testing directory.
  • Executes successfully locally.
  • Style checker executes successfully by the GitHub runner (pipeline).
• Documentation:
  • README.md of all code touched, including unit tests:
    • Has been read to asses what additions and updates should be made.
    • Has been updated.
  • Script/Function/Help doc of all code touched (if you touch the file, you own all documentation updates):
    • Has been read to asses what additions and updates should be made.
    • Has been updated.
• Testing:
  • New code:
    • Has 100% Unit test coverage (other than main.sh files).
    • Is run by a GitHub workflow (the pipeline).
    • Runs successfully by GitHub runner (the pipeline).
    • New unit tests are being run by GitHub actions (pipeline).
  • Coverage:
    • Unit test coverage of all code touched has not dropped.
    • 100% coverage exists for all added code.
    • Checked if unit test coverage has increased, if so:
      • Update GitHub workflows .yml files that run the unit tests in the pipeline to increase the minimum coverage level required for pipeline success.
  • All tests (unit, functional, or otherwise) run successfully:
    • By GitHub runner (the pipeline).
    • Locally.
  • If new environment variable(s) were added:
    • Environment variables are unset by the spec_helper_precheck() function in <repoRoot>/spec/spec_helper.sh.
    • All unit tests of the code that uses them set or unset them at the top or within the test.
    • 100% Unit test coverage of environment variable(s).
• PR is not marked as Draft.