Add API documentation, GitHub Actions for code quality and tests #8
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
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
ikretz
changed the title
sobregosodd
approved these changes
Sep 3, 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.
This PR adds support for building API documentation via
pdocas well as two GitHub Actions for enforcing code quality (type checking and linting) and testing on pull request and pushing tomain.Matrix testing is used to ensure compatibility with various versions of
pipandnpm. This testing revealed that the firewall's current approach to parsing the output ofnpmdry-run commands is too dependent on this output having a certain format that is in fact only used in recent (i.e.,>=10.x) versions ofnpm, precluding us from supporting more versions. This will need to be addressed in a separate PR. For now, a "disclaimer" has been added to the README regardingnpm(andpip) compatibility, informed by these tests.