You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/process/dev-workstation-setup.md
+47-40Lines changed: 47 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,24 +9,6 @@ This page describes how to setup a Mac OS X workstation to work on Narrative's p
9
9
10
10
## Common System Tools
11
11
12
-
### git
13
-
14
-
```shell
15
-
brew install git
16
-
```
17
-
To address vulnerabilities like [this](https://github.blog/open-source/git/git-security-vulnerabilities-announced-6/)
18
-
you need to ensure that built-in `/usr/bin/git`**is not being used** neither in CLI nor in any IDE you use to commit changes.
19
-
20
-
You can catch divergence in CLI.
21
-
```shell
22
-
git --version
23
-
git version 2.50.1
24
-
25
-
/usr/bin/git --version
26
-
git version 2.39.3 (Apple Git-145)
27
-
```
28
-
And for an IDE, it is necessary to set (or ensure that it was automatically configured) `/opt/homebrew/bin/git` location.
29
-
30
12
### Xcode
31
13
32
14
The Apple development tools takes quite a while (1hr) to download and it will be required later in the installation, so make sure you start the download first, then continue the installation instructions while it is downloading.
@@ -309,44 +291,48 @@ Once it is installed,
309
291
310
292
### Git
311
293
312
-
[Git](https://git-scm.com/) is a distributed version control system
313
-
314
-
NOTE: Xcode is required at this step, wait until XCode to run this. If it is not finished, you can run the other steps and come back to this one once it's finished.
294
+
We use [Git](https://git-scm.com/) and GitHub.
315
295
296
+
NOTE: Xcode is required at this step; wait until XCode is installed to run this. If it is not finished, you can run the
297
+
other steps and come back to this one once it's finished.
316
298
317
-
Install
299
+
Install:
318
300
```bash
319
301
sudo xcodebuild -license accept
320
302
brew install git
321
303
```
322
304
323
-
Configure
324
-
325
-
The minimum configuration would look like
305
+
The minimum configuration would look like:
326
306
327
307
```bash
328
308
git config --global user.name "Your Name"
329
309
git config --global user.email you@narrative.io
330
310
```
331
311
332
-
Generate Github SSH Key
312
+
Generate Github SSH Key:
333
313
334
314
```bash
335
315
ssh-keygen
336
316
```
337
317
338
318
Then manually upload `~/.ssh/id_rsa.pub` to [github](http://www.github.com) (Settings -> SSH and GPG Keys)
339
319
340
-
Install hub
320
+
To ensure we can address vulnerabilities like [this](https://github.blog/open-source/git/git-security-vulnerabilities-announced-6/)
321
+
in a timely way by running `brew upgrade git`, you need to ensure that built-in `/usr/bin/git` **is not being used**
You can check if your CLI is using the right version by running:
343
325
344
-
```bash
345
-
brew install hub
346
-
echo 'alias git=hub' > ~/.zshrc.d/hub
347
-
source ~/.zshrc.d/hub
326
+
```shell
327
+
git --version
328
+
git version 2.50.1
329
+
330
+
/usr/bin/git --version
331
+
git version 2.39.3 (Apple Git-145)
348
332
```
349
333
334
+
For IDEs, it is necessary to set (or ensure that it was automatically configured) `/opt/homebrew/bin/git` location.
335
+
350
336
## AWS Tools
351
337
352
338
### AWS Command-Line Tools
@@ -443,6 +429,35 @@ Install
443
429
</base-code-block>
444
430
</base-code-group>
445
431
432
+
#### GitHub Packages Credentials
433
+
434
+
Our shared build plugin (`common-build`) is published to GitHub Packages. To resolve it locally, you need to create a Personal Access Token (PAT) and configure sbt to use it.
435
+
436
+
**1. Create a Personal Access Token (PAT)**
437
+
438
+
Go to [Settings → Developer Settings → Personal Access Tokens](https://github.com/settings/tokens) and create a classic PAT with `read:packages` permissions.
0 commit comments