Skip to content

Commit

Permalink
📝 Improve plugins docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixr-codes committed Oct 12, 2024
1 parent 479f9d2 commit bfdc773
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions manual/src/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ the paths in the temporary directory ("prebuilt directory").

- `ALLAY_DEBUG` --- Whether the project is built in debug mode.
- `ALLAY_PREBUILD` --- The root of the prebuilt directory.
- `ALLAY_PROJECT_ROOT` --- The root of the project root (the directory with the `allay.toml` file).
- `ALLAY_PROJECT_ROOT` --- The path to the root of the project (the directory with the `allay.toml` file).
- `ALLAY_VERSION` --- The version of Allay that is beeing used.

On top of that users may define extra environment variables in the [`[env]`](./configuration.md#env) section of the configuration file.
On top of that users may define extra environment variables in the
[`[env]`](./configuration.md#the-env-section) section of the configuration file.


### Configuration
Expand Down Expand Up @@ -77,7 +78,7 @@ To tell Ally to run this plugin, we need to mention it in the `allay.toml` file.
# ...

[[plugin]]
run = "scripts/info.py"
run = "plugins/info.py"
with = "python3"
```

Expand All @@ -95,7 +96,7 @@ adding the `when` field:
# ...

[[plugin]]
run = "scripts/info.py"
run = "plugins/info.py"
with = "python3"
when = 'env("ALLAY_DEBUG") == "1"'
```
Expand Down

0 comments on commit bfdc773

Please sign in to comment.