Skip to content

Commit

Permalink
📝 add how to validate locally (#135)
Browse files Browse the repository at this point in the history
  • Loading branch information
AucaCoyan authored Nov 2, 2024
1 parent cb066a9 commit 3b28c9d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,6 @@ dmypy.json

# macOS files that should be excluded from git
.DS_Store

validation_report.md

29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,32 @@ To be clear about the implications of using scripts in packages. We need to doub
- even if the package does not contain scripts, it needs a human reviewer nonetheless: it might have content that we don't want to be part of distributing, such as offensive/hateful language or images

The process of creating this review policy can be tracked in [#98](https://github.com/espanso/hub/issues/98)

## Run the package validation locally

Sometimes it's useful to run the validation process locally. To do so, you have
to make the following steps:

- have python 3.12 installed and make an environment in your local folder. We
use [`uv`](https://github.com/astral-sh/uv) often, and if you don't know it yet
, you should!

```bash
uv venv --python 3.12
```

- install the `pyyaml` dependency

```bash
uv pip install pyyaml
```

- run the `main.py` *from the root folder* (because the script uses `glob` to
find what packages are in the `packages/` folder)

```bash
uv run .github/scripts/validate/main.py
```

- wait until you have the results!

0 comments on commit 3b28c9d

Please sign in to comment.