Document recommended method(s) to set environment variables when environments containing a package are activated

[mfisher87]

I help maintain a Conda Forge feedstock, and a user of the package reported problems using the package with Fish. The root cause was our activation scripts not being compatible with their shell, and the docs include a prescient warning:

It is generally recommended to avoid using activate scripts when another option is possible because people do not always activate environments the expected way and these packages may then misbehave.

I'm trying to understand what alternatives are available to me, and I came across some pre-existing discussion which included mention of a mechanism to set envvars using a JSON key-value mapping.

I found the PR that introduced this functionality, but I haven't found any documentation. Is this mechanism deliberately un-documented because it's unsupported? Or is it anticipated that the recipe format will be updated to support this feature to provide a more mature API (#4833)?

After consideration of the above, I'd be happy to help document what it would look like to create this JSON mapping at build-time using a script. I think it would be especially useful to update the Activate Scripts page which I quoted above to point out preferred mechanism(s).

Thanks for your consideration!

PS: While I'm in there, I see the prose on this doc page includes "The installed scripts are recommended to be prefixed by the package name and a separating -.", but both examples use an _ instead. Which is the true intent of the docs? I'll fix that too :)

[mfisher87]

After a bit of source-digging, I see that the Fish shell, among many others, seems to be supported for setting envvars from these JSON files, eliminating the need for activation scripts. I'm feeling really good about this option for our recipe now!

[travishathaway]

Hi @mfisher87,

Would you recommend us to update this page in any way?

• https://docs.conda.io/projects/conda-build/en/stable/resources/activate-scripts.html

[mfisher87]

@travishathaway yes, I think that's a good option (assuming this is a feature Conda wants to advertise). In that case, I feel it would make the most sense to rename the page to "activation automation" or "activation hooks" or something more general. I think it should be structured like:

Activation hooks

There are multiple ways to automate tasks that occur at environment activation time:

• env_vars.d enables setting environment variables in a way that maximizes compatibility.
• Activation scripts allow arbitrary shell scripts to run. Note that these will only work for compatible shells, so this method is not advised for setting environment variables. (NOTE: Perhaps most users use bash, but we could recommend writing for sh to further improve compatibility for Linux scripts?)

env_vars.d

{instructions}

Activation scripts

{instructions}

[mfisher87]

@travishathaway I see you've marked this good first issue, and to me that implies that my recommendation above is sound. Can you confirm explicitly for me, and then I'll start work on this doc page? Thank you!

[github-actions]

Hi there, thank you for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this issue to remain open please:

1. Verify that you can still reproduce the issue at hand
2. Comment that the issue is still reproducible and include:
   - What OS and version you reproduced the issue on
   - What steps you followed to reproduce the issue

NOTE: If this issue was closed prematurely, please leave a comment.

Thanks!

[travishathaway]

@mfisher87,

Apologize for my delayed response (oh how the years go by! 😂).

Yes, this would be a good issue for you to work on. Let me know if you're still interested, and I can assign it to you.

[mfisher87]

Hey Travis, thanks for your response! I understand how it is :) Please assign and I'll take a stab at the docs!