Skip to content

Commit

Permalink
[BE][CI] - add a github PR template and CI workflow migration (#282)
Browse files Browse the repository at this point in the history
* add a PR template and a workflow mirroring the current circleci pre-commit job

* remove circleci config and mentions
  • Loading branch information
aclegg3 authored Dec 3, 2024
1 parent 9cbe558 commit 1850c2d
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 35 deletions.
29 changes: 0 additions & 29 deletions .circleci/config.yml

This file was deleted.

26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
<!--- Link to existing issues or related PRs here if they exists. -->

## How Has This Been Tested

<!--- Please describe here how your modifications have been tested. -->

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
27 changes: 27 additions & 0 deletions .github/workflows/run_pre-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Run pre-commit
on:
pull_request: {}
push:
branches:
- main

jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- name: Setup python
uses: actions/setup-python@v5.0.0
with:
python-version: '3.9.16'
- name: install dependencies
run: |-
pip install -U pip setuptools pre-commit
# Install the hooks now so that they'll be cached
pre-commit install-hooks
- name: Check Code Style using pre-commit
run: |-
SKIP=eslint pre-commit run --show-diff-on-failure --all-files
#NOTE: use the below to debug with ssh: simply move this "job" just before the crashing job to intercept the workflow
#- name: Debugging with tmate
# uses: mxschmitt/action-tmate@v3.18
6 changes: 0 additions & 6 deletions installation/SETUP_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,10 +285,4 @@ Installing the pre-commit allows you to run automatic pre-commit while running `
pre-commit install
```

### Creating an account on CircleCI
- Since we have integrated CircleCI tests on this repo, you would need to create and link your CircleCI account
- You can create your account from this link (https://app.circleci.com/). Once you have created the account, go to "Organization Settings", on the left tab click on "VCS"
- Finally click on "Manage GitHub Checks". CircleCI will request access to `facebookresearch` org owner.
`
### For folks running Aria-Spot codebase, please also refer to the additonal setup steps [mentioned in this readme](/aria_data_loaders/README.md)

0 comments on commit 1850c2d

Please sign in to comment.