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

Adding workflows for unit tests and linting #11

Merged
merged 18 commits into from
Sep 16, 2024

Conversation

ericbuckley
Copy link
Collaborator

@ericbuckley ericbuckley commented Sep 10, 2024

Description

Adding 4 different GitHub workflows to help with managing code checks.

  1. unit tests
  2. linting
  3. code vulnerabilities
  4. dependency vulnerabilities

Related Issues

closes #7

Additional Notes

Also removing the scripts/vulnerability_checks.sh script as we're going to try using GH tools (ie CodeQL and Dependabot) for managing those checks and won't need an independent script for it anymore.

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.
  • I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@ericbuckley ericbuckley added the enhancement New feature or request label Sep 10, 2024
@ericbuckley ericbuckley self-assigned this Sep 10, 2024
@ericbuckley ericbuckley marked this pull request as ready for review September 11, 2024 21:17
alhayward
alhayward previously approved these changes Sep 13, 2024
Copy link
Collaborator

@alhayward alhayward left a comment

Choose a reason for hiding this comment

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

I'm less familiar with GH Workflows, CodeQL, and Dependabot, so I defer to @derekadombek, but LGMT!

Is there any way I can test these changes/tests locally?

.github/dependabot.yml Show resolved Hide resolved
.github/workflows/check_lint.yml Show resolved Hide resolved
.github/workflows/check_unit_tests.yml Show resolved Hide resolved
alhayward
alhayward previously approved these changes Sep 13, 2024
.github/workflows/check_unit_tests.yml Outdated Show resolved Hide resolved
.github/workflows/check_unit_tests.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@alhayward alhayward left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for your responses!

@ericbuckley ericbuckley merged commit ba43da1 into main Sep 16, 2024
4 checks passed
@ericbuckley ericbuckley deleted the ericbuckley/7-setup-ci-workflow branch September 16, 2024 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Setup CI workflow to run tests, linting and vulnerability checks
3 participants