Code update: refactor the way the report files are defined in the command line and passed into the configure_reports function #147
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion's parameters
…ms in report_params.py
…new configure_report input in test_output.py
|
Hello @rebekahrudd can you please give us several examples of the way in which you have changed the code and, in particular, can you clarify whether or not these refactorings are going to change the output and/or behavior of GatorGrade? |
|
The inputs to Here is a screenshot of the updated help menu: |
hemanialaparthi
approved these changes
Oct 28, 2024
There was a problem hiding this comment.
@rebekahrudd! I just tested this out locally and my --help function has the intented output:
(venv) hemanialaparthi@Hemanis-MacBook-Air executable-examination-example-solution % gatorgrade --help
Usage: gatorgrade [OPTIONS] COMMAND [ARGS]...
🐊 Run the GatorGrader checks in the specified gatorgrade.yml file.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --config -c PATH Name of the yml file. [default: gatorgrade.yml] │
│ --report-location [file|env] [default: None] │
│ --report-storing-type [json|md] [default: None] │
│ --storing-location-name [github] [default: None] │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯And, I can see my GitHub Actions reporting the insights:
NOTE: for future people testing this PR, the build.yml file is in the .github and also if you don't see your GitHub Actions, make sure you check if you have them enable for your repo.
CalebKendra
approved these changes
Oct 28, 2024
suppo01
reviewed
Oct 31, 2024
CalebKendra
approved these changes
Nov 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Code update: refactor the way the report files are defined in the command line and passed into the configure_reports function
Description
This latest change to
gatorgradeis to refactor the code that configures the report. This update changes the command line interface and the commands that are passed in. There is no longer a `--report`` command rather there are three that address different aspects.The purpose of this is to have better documentation for users to understand the acceptable options for each part of generating a report.
Linked Issues
https://github.com/GatorEducator/gatorgrade/issues/145
closes: #145
Type of Change
Contributors
Testing this PR
Setup:
gatorgradeto test thisgatorgradeupdate.pyproject.tomlfile of the repo you chose add the commandpipx install git+https://github.com/rebekahrudd/gatorgradein place of the commandpipx install gatorgradeHow to check if this PR worked:
gatorgradeIf you see the report and have confirmed that it was my version of Github that ran then this update is working and this PR can get approved!