Skip to content

Commit

Permalink
Update README and Taskfile.yml for easier new-dev setup (#1117)
Browse files Browse the repository at this point in the history
* Check out git submodules in `task setup`

If the user cloned the git repo without `--recurse-submodules`, then
running `task setup` will take care of the necessary step without
needing to add a note to the README file (which is visible when looking
at the repo on GitHub before cloning, but many people will clone the
repo first and THEN look at the README).

* Improve first-time setup instructions for new devs

New devs might not know that they need to change the PowerShell
execution policy to allow scripts, and also might not be familiar with
how to set the PATH variable on Windows. So we'll add slightly more
detailed instructions to the README.
  • Loading branch information
rmunn authored Oct 15, 2024
1 parent 7e175df commit 0d354f7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,23 @@ Other files, like `skaffold.yaml`, should be at the root of the repo, because th
* mac: `brew install go-task/tap/go-task`
* via npm: `npm install -g @go-task/cli`
* install [Skaffold](https://skaffold.dev/docs/install/#standalone-binary) and add it to your path
* the file you will download is **NOT** an installer, just a standalone runnable .exe (on Windows) or binary (on Linux)
* on Linux, a good practice is to create `$HOME/.local/bin` and put binaries there; most distributions automatically add `$HOME/.local/bin` to your path if it exists
* don't forget to run `chmod +x $HOME/.local/bin/skaffold`
* on Windows, we suggest creating a `bin` folder in your home folder. Put the Skaffold binary there, then do the following:
* go to your System properties, click the **Advanced** tab, and click **Environment Variables...**
* Click the Path variable (in either User or System, User is recommended) and click the **Edit...** button
* Add `C:\Users\YOUR_USER_NAME\bin` to the list and click **OK**
* clone the repo
* run setup `task setup`, which:
* run `git push` to make sure your GitHub credentials are set up
* on Windows, allow the Git Credential Manager to log in to GitHub via your browser
* on Linux, upload your SSH key to your GitHub account if you haven't done so already, then run `git remote set-url --push origin [email protected]:sillsdev/languageforge-lexbox`
* on Windows, open PowerShell and run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned`
* this is necessary before running `task setup` below, which uses a PowerShell script to download seed data
* run `task setup`, which:
* initializes a local.env file
* tells Git to use our ignore revs file
* checks out Git submodules
* downloads the FLEx repo for the project seed data

#### Extra setup steps for Windows
Expand Down
3 changes: 3 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ tasks:
deps: [ setup-win, setup-unix ]
cmds:
- git config blame.ignoreRevsFile .git-blame-ignore-revs
- git submodule init
- git submodule update --recursive
- git config --local submodule.recurse true
- kubectl --context=docker-desktop apply -f deployment/setup/namespace.yaml
- kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.15.0/cert-manager.yaml
- docker build -t local-dev-init data/
Expand Down

0 comments on commit 0d354f7

Please sign in to comment.