Skip to content

docs: document issue with direnv and nix-shell on macOS #15990

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

Merged
merged 1 commit into from
Jan 2, 2025
Merged

docs: document issue with direnv and nix-shell on macOS #15990

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
7 changes: 7 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ direnv: export +AR +AS +CC +CONFIG_SHELL +CXX +HOST_PATH +IN_NIX_SHELL +LD +NIX_
🎉
```

> **Note:** On macOS, a [direnv bug](https://github.com/direnv/direnv/issues/1345) can cause `nix-shell` to fail to build or run `coder`. If you see `error: creating directory` when attempting to run, build, or test, adding one line to your `.envrc` should fix the problem:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, I would create a subsection for Troubleshooting and mention this issue. Otherwise, there is a risk we'll end up with 10 notes referring different issues.

I'll defer the final decision to @EdwardAngert 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @paulroub ! I do agree with @mtojek , but there are a few more (unrelated) things I want to edit in this doc. I'll approve this as is, and follow-up in a little while

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a trick (beyond commenting "recheck", which isn't doing it) to have the contrib / cla check redone?

Copy link
Contributor

@EdwardAngert EdwardAngert Jan 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might just be busted, @paulroub

I had this issue with some of my own PRs - some I was able to fix when I confirmed my git config user and email (pasting below, just in case), and some just still fail. We're working on figuring out why and fixing it, but it's not a required check for us to merge

git config --local user.name "myusername" && \
git config --local user.email "no-reply-email+myusername@users.noreply.github.com"

edit: scratch that - looks like you've been added in coder/cla@061cd21


```shell
use nix
mkdir -p "$TMPDIR"
```

Alternatively if you do not want to use nix then you'll need to install the need
the following tools by hand:

Expand Down
Loading