Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/report bug #134

Merged
merged 50 commits into from
Oct 5, 2024
Merged

Fix/report bug #134

merged 50 commits into from
Oct 5, 2024

Conversation

gkapfham
Copy link
Collaborator

@gkapfham gkapfham commented Oct 3, 2024

Tentative Fix for the Report Generation Defect

Description

Aims to give the problems with (i) the build failing and (ii) defective release to PyPI. The main problem is that the command gatorgrade --report env md GITHUB_STEP_SUMMARY seems to crash when it is run in GitHub Actions with this feature. This PR also resolves several defects where, for instance, gatorgrade will crash when it is run on a laptop with the aforementioned command --- even though that command will, in fact, work correctly when it is run in GitHub Actions. It is also important to note that this PR moves this project over to the use of ruff and stops the use of other tools like pylint. Finally, the PR removes one or two test cases that were flaky and no longer running predictably.

Type of Change

  • Feature
  • Bug fix
  • Documentation

Contributors

Reminder

  • All GitHub Actions should be in a passing state before any pull request is merged.
  • All PRs must be reviewed by at least one team member and one member of the Integration team!
  • Any issues this PR closes are tagged in the description!

Notes

This is currently a draft PR so that others can see the progress that @rebekahrudd is making and to then give feedback and try it out and to suggest additional fixes as needed. Thanks!

@gkapfham gkapfham added bug Something isn't working enhancement New feature or request labels Oct 3, 2024
@gkapfham gkapfham marked this pull request as draft October 3, 2024 18:46
@gkapfham gkapfham mentioned this pull request Oct 3, 2024
3 tasks
@rebekahrudd rebekahrudd marked this pull request as ready for review October 3, 2024 23:06
…ut/output.py so it only writes to GITHUB_ENV when it is set.
@gkapfham
Copy link
Collaborator Author

gkapfham commented Oct 5, 2024

@rebekahrudd I think that this PR resolves all of the issues that we discussed on Thursday and Friday of this week. Due to the fact that I am facing severe time constraints in light of upcoming travel, I am going to merge the PR and make a new release to PyPI and then invite other members of our team to test it further. I will also test it through some existing assignments and confirm that everything works in GitHub Actions and that the new diagnostic messages are also output when run either in GitHub Actions or in the terminal window on a laptop.

@gkapfham gkapfham merged commit 5299c29 into main Oct 5, 2024
14 checks passed
@gkapfham gkapfham deleted the fix/report_bug branch October 5, 2024 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants