Skip to content

Commit 46e5d42

Browse files
authored
[BE] [ez] READMEs - update lint/formatter info, remove dup info about hud (#6367)
As in title * Update the lint/formatter info * Remove the dup info about development on HUD and link to the torchci README instead
1 parent 52e4e56 commit 46e5d42

File tree

2 files changed

+6
-27
lines changed

2 files changed

+6
-27
lines changed

README.md

+3-27
Original file line numberDiff line numberDiff line change
@@ -31,35 +31,11 @@ $ git clone --recursive https://github.com/pytorch/test-infra
3131
```
3232

3333
## Setting up your Dev environment to locally run hud.pytorch.org
34-
1. Install yarn:
35-
E.g. for macs: `brew install yarn`
36-
2. `cd torchci` and install dependencies with `yarn install`
37-
2. Setup your environment variables
38-
39-
a. Copy `torchci/.env.example` to `torchci/.env.local` to create a local copy of your environmnet variables. This will NOT be checked into git
40-
41-
b. For every environment setting defined in there, copy over the corresponding value [from Vercel](https://vercel.com/fbopensource/torchci/settings/environment-variables) (this requires access to our Vercel deployment)
42-
43-
3. From `torchci` run `yarn dev` to start the dev server. The local endpoint will be printed on the console, it'll most likely be `http://localhost:3000`. You can find more useful yarn commands in `package.json` under the `scripts` section.
34+
See the [README.md in `torchci`](https://github.com/pytorch/test-infra/blob/main/torchci/README.md).
4435

4536
## Linting
46-
47-
We use [`actionlint`](https://github.com/rhysd/actionlint) to verify that the GitHub Actions workflows in [`.github/workflows`](github/workflows) are correct. To run it locally:
48-
49-
1. [Set up Go](https://golang.org/doc/install)
50-
2. Install actionlint
51-
52-
```bash
53-
go install github.com/rhysd/actionlint/cmd/actionlint@7040327ca40aefd92888871131adc30c7d9c1b6d
54-
```
55-
3. Run actionlint
56-
57-
```bash
58-
# The executable will be in ~/go/bin, so make sure that's on your PATH
59-
# actionlint automatically detects and uses shellcheck, so if it's not in
60-
# your PATH you will get different results than in CI
61-
actionlint
62-
```
37+
We use [`lintrunner`](https://pypi.org/project/lintrunner/) for linting and
38+
formatting. `torchci` also uses `yarn`.
6339

6440
## Join the PyTorch TestInfra community
6541
See the [`CONTRIBUTING`](CONTRIBUTING.md) file for how to help out.

torchci/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the
3737
result! Any edits you make to the code will be reflected immediately in the
3838
browser. You can also run our test suite with `yarn test`.
3939

40+
You can find additional yarn commands in `package.json` under the `scripts`
41+
section, such as `yarn test` to run the test suite.
42+
4043
We use Next.js as our framework. To learn more about Next.js, take a look at the
4144
following resources:
4245

0 commit comments

Comments
 (0)