Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): note for custom env like RUST_LOG #37

Merged
merged 1 commit into from
Jan 20, 2025
Merged

docs(readme): note for custom env like RUST_LOG #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ This action takes the following parameters:

### Setting Environment Variables

You can simply set an `env` key in the workflow step that uses this action, for example:
By default, `cross` passes most rust-related environment variables through when it runs `cargo` in a
Docker image. This means you can simply set an `env` key in the workflow step that uses this action.

```
- name: Run build command
Expand All @@ -96,6 +97,11 @@ You can simply set an `env` key in the workflow step that uses this action, for
command: build
```

If you want to pass other environment variables through, you will need to configure `cross` to do
see. See the
[`cross` docs](https://github.com/cross-rs/cross/blob/main/docs/environment_variables.md#environment-variable-passthrough)
for more details.

## How it Works

Under the hood, this action will compile your binaries with either `cargo` or `cross`, depending on
Expand Down
Loading