https://github.com/pytorch/ci-hud
HUD for CI activity on `pytorch/pytorch`, provides a top level view for jobs to easily discern regressions
https://github.com/pytorch/ci-hud
pytorch react
Last synced: 3 months ago
JSON representation
HUD for CI activity on `pytorch/pytorch`, provides a top level view for jobs to easily discern regressions
- Host: GitHub
- URL: https://github.com/pytorch/ci-hud
- Owner: pytorch
- License: mit
- Archived: true
- Created: 2018-03-02T03:05:11.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2022-02-26T10:54:19.000Z (almost 4 years ago)
- Last Synced: 2024-09-27T20:03:22.404Z (over 1 year ago)
- Topics: pytorch, react
- Language: JavaScript
- Homepage: https://hud.pytorch.org
- Size: 34.9 MB
- Stars: 11
- Watchers: 5
- Forks: 26
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [PyTorch CI HUD](https://hud.pytorch.org)
Visit https://hud.pytorch.org and see https://github.com/pytorch/pytorch/wiki/Using-hud.pytorch.org for usage details.
## Development
This project was bootstrapped with [Create React App](https://create-react-app.dev). To build locally, install dependencies and run in develop mode:
```bash
git clone https://github.com/pytorch/pytorch-ci-hud.git ci-hud
cd ci-hud
yarn install
npm start # start a development server on localhost:3000
```
The code is routed from [`App.js`](src/App.js) to places like:
- [`PrDisplay.js`](src/PrDisplay.js): handles the per commit/PR pages with test results
- [`GitHubStatusDisplay.js`](src/GitHubStatusDisplay.js): shows status for a set of commits on master or a release branch. This also depends on this [lambda function](https://github.com/pytorch/test-infra/tree/main/aws/lambda/github-status-webhook-handler) to read GitHub [`status`](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#status) and [`check_run`](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run) webhooks and store them in S3 as JSON.
### Submitting a PR
Submitting a PR will trigger a [preview build](https://www.netlify.com/products/deploy-previews/) on Netlify so others can preview the changes. Once merged, [GitHub Actions](https://github.com/pytorch/pytorch-ci-hud/blob/main/.github/workflows/ci.yml) will deploy the new site to the [`gh-pages`](https://github.com/pytorch/pytorch-ci-hud/tree/gh-pages) branch.
### Log-ins for Local Development and Deploy Previews
Log-ins don't work on the Netlify deploy previews since the GitHub app has hud.pytorch.org hardcoded as its callback URL. To see changes that require the GitHub API in a preview you can manually copy your OAuth token. In the JS console on hud.pytorch.org, run `localStorage.getItem("gh_pat")`. Then in the preview's console, run `localStorage.setItem("gh_pat", "")`.
## Data
The data backing the HUD is updated via a series of cron-based GitHub Actions. See [`.github/`](.github) for details.
## License
This repository uses the MIT License, as found in the [LICENSE](LICENSE) file.