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 mypy Error and Correct Platforms in README #21

Merged
merged 3 commits into from
Oct 5, 2021
Merged

Conversation

mcdonnnj
Copy link
Member

@mcdonnnj mcdonnnj commented Sep 29, 2021

🗣 Description

This PR fixes a mypy error and corrects an oversight in the project's README.

💭 Motivation and context

The latest cisagov/action-apb triggered GitHub Actions run had the following error:

src/vdp_scanner.py:258: error: Argument 2 to "str" has incompatible type "Optional[str]"; expected "str"

In the process of resolving that issue I noticed that the README did not have the correct platforms listed so I corrected them while I was working on the repo.

🧪 Testing

Automated tests pass. A local testing image ran as expected.

✅ Checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated
    to reflect the changes in this PR.
  • All new and existing tests pass.

This resolves the following error seen in GitHub Actions runs:

src/vdp_scanner.py:258: error: Argument 2 to "str" has incompatible type "Optional[str]"; expected "str"

This error flags because the `encoding` property of a response object is not
guaranteed to be set, but the str() function requires a string value for its
second argument.
The platform shield in the README still used the default platforms from
cisagov/skeleton-docker, but this Docker project only supports a subset of
those platforms.
@mcdonnnj mcdonnnj added the bug This issue or pull request addresses broken functionality label Sep 29, 2021
@mcdonnnj mcdonnnj self-assigned this Sep 29, 2021
@mcdonnnj mcdonnnj requested a review from jsf9k as a code owner September 29, 2021 18:44
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean up all the thangs! ✨

@mcdonnnj
Copy link
Member Author

mcdonnnj commented Oct 5, 2021

Switched this to a release candidate because I will be stacking in multiple PRs for the final 0.0.5 version.

@mcdonnnj mcdonnnj merged commit ce100dc into develop Oct 5, 2021
@mcdonnnj mcdonnnj deleted the bug/small_fixes branch October 5, 2021 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue or pull request addresses broken functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants