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.

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

Hooks env variables documentation #2847

Closed
MarkoMin opened this issue Nov 16, 2023 · 1 comment · Fixed by tsloughter/rebar3.org#128
Closed

Hooks env variables documentation #2847

MarkoMin opened this issue Nov 16, 2023 · 1 comment · Fixed by tsloughter/rebar3.org#128

Comments

@MarkoMin
Copy link
Contributor

There are environment variables that get exported for running hooks (link), but I struggle to find them in the documentation. I had this issue which was resolved by using one of those variables and IMO it would make sense to document those variables in "Hooks" section of rebar3 docs.

I could come with a PR, if anyone can confirm that:

  1. they're not already documented somewhere (I tried to find them, but with no success)
  2. it would make sense to document these
@ferd
Copy link
Collaborator

ferd commented Nov 17, 2023

The rebar_env module is the canonical source of variables, yeah. It appears we never clarified all the variables in the docsite, but we probably should add them.

Part of the challenge will be also that rebar_dir isn't really documented either, and maybe it would eventually fit under the plugin documentation but we can ignore that extension to docs for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants