Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/TakeTwo-DataScience

Create GitHub actions to test new code before merging

Open
#24 2 comments 0 reactions 0 assignees View on GitHub
CI/CD Machine Learning stale
Dominant language
Jupyter Notebook
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

### Background on the problem the feature will solve/improved user experience
Add GitHub Actions to test and build new code pushed to a branch or committed to a pull request. Code that passes all the steps in the GitHub action can be merged in the repository.

Prerequisite: This should be installed after we start adding python code to this repo.

### Describe the solution you'd like
A GitHub action runs whenever code is committed to any branch or PR is made to the main branch.

Each action will
- [ ] install dependencies
- [ ] build for production
- [ ] run all tests
- [ ] linting, we haven't chosen a linter so let's discuss options in the comments

### Tasks
- [ ] Ensure install, build and lint steps run locally on your system
- [ ] Read more about [GitHub actions](https://docs.github.com/en/actions/learn-github-actions), in the Build and Test section
- [ ] Create GitHub actions for each folder described above. You can read more [Python build actions here](https://docs.github.com/actions/automating-builds-and-tests/building-and-testing-nodejs-or-python?langId=py).
- [ ] Commit and push your GitHub action code.
- [ ] Go to the [Actions tab](https://github.com/Call-for-Code-for-Racial-Justice/TakeTwo-DataScience/actions) to see if it worked.

### Acceptance Criteria
- GitHub action runs for every new code commit and PR.

FYI @upkarlidder

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.