Document Syncing Code

[wildintellect]

This is just a VS Code specific annoyance, that there's no easy/good way to have your code show up on the remote machine. https://code.visualstudio.com/docs/remote/ssh#_working-with-local-tools

[wildintellect]

As an update to this, I think I saw that a repo using github actions blocks https authentication, so you can't clone to the remote machine without a private key on it?

[wildintellect]

Documenting Options:

1. rsync (sync file to the remote as needed)
2. sshfs (mount the remote locally and copy files, or work directly on them)
3. include repo clone in Dockerfile
4. use Github personal authentication token with https to pull/push changes on the remote
5. use a Deploy key to allow pull only access to code on the remote

Opinion: I prefer option 5, all code is edited locally, checked into git, pushed, then pulled with a deploy key on the remote. Why:

• avoids having to rebuild the docker image on every edit
• makes it easier to avoid forgetting to put something into version control
• easier to use than rsync or sshfs (though you still need to add the deploy key to use it)
• encourages you not to develop directly on the remote machine but rather use the remote for testing and execution
• avoids putting a private key with write permissions on a remote machine, doesn't require repasting a token every time you want to pull (could avoid with an ENV variable)

Note: options 4 & 5 require git to be installed in the docker image. TODO: add to the notes/example on building a docker image for remote use.

Option 1 is probably the next best choice: simplest to setup, need some simple rsync examples that explain what flags and how to do the paths right.