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

dev-desktop: Git email config docs doesn't match implementation #681

Open
aDotInTheVoid opened this issue Apr 14, 2023 · 0 comments
Open
Labels
T-infra Team: Infrastructure

Comments

@aDotInTheVoid
Copy link
Member

The dev-desktop docs say you should check that your email has been setup before running init.sh

## How to set up your account
When connecting to the machine for the first time, there are a few things you
might want to do.
First, check that your Git username and email are configured correctly.
```shell
git config -l --global
```
You can configure your username and email address with:
```shell
git config --global user.name "Your name"
git config --global user.email "your-email"
```
## How to install a Rust toolchain
The dev desktops don’t have Rust pre-installed, but instead make it easy to
install a specific toolchain from a local repository or worktree.
First, you want to run the following command to install `rustup`:
```shell
/usr/local/bin/init.sh
```

However running init.sh is what sets up a users git to have their name and email (from rust-lang/team)

https://github.com/rust-lang/simpleinfra/blob/f913b2b4d76b327031c3be225d54dc7e8a940241/ansible/roles/dev-desktop/files/scripts/init.sh#L8

We should change the docs to first have user's run init.sh, and then check that their gitconfig is correct.

@ehuss ehuss added the T-infra Team: Infrastructure label Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-infra Team: Infrastructure
Projects
None yet
Development

No branches or pull requests

2 participants