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

Update README and Taskfile.yml for easier new-dev setup #1117

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
2 changes: 2 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ tasks:
deps: [ setup-win, setup-unix ]
cmds:
- git config blame.ignoreRevsFile .git-blame-ignore-revs
- git submodule init
- git submodule update --recursive
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this would be a valuable addition:

Suggested change
- git submodule update --recursive
- git submodule update --recursive
- git config --global 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