Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.6 KB

2-tracking-changes-privately.md

File metadata and controls

53 lines (34 loc) · 1.6 KB

Tracking your changes

When using Cast in your environment, you may have to modify settings or code.
As much as possible, try avoiding editing any source code so that your repository can
be updated easily when a new version of Cast/HPC Client is released. Keeping this repository tracked in version control, outside the HPC, will save a lot of headaches later.

Since this repository is open-source, the normal "fork" button won't do the job.
This is very important if you choose to version your credentials, which is recommended.

  1. Create a new GitHub repository. Set it to private.

  2. Click "Settings" -> "Manage access" -> add any desired collaborators.
    In particular, whichever Flywheel staff member(s) you may be working with.

  3. Switch to the "Deploy keys" section, then generate a new ssh key on the terminal. Leave the passphrase blank:

ssh-keygen -t ed25519 -C fw-cast-deploy-key -f ./fw-cast-deploy-key

cat fw-cast-deploy-key.pub

  1. Click "Add deploy key", and paste the public key's contents into the page. You may want to tick the box to give it write access also.

  2. Copy this key to your HPC for use later:

scp fw-cast-deploy-key <your-hpc-host>:
  1. Move Flywheel Cast to your private copy:
git clone https://github.com/flywheel-io/fw-cast

cd fw-cast

git remote add private <your-github-location>

git push private --all
  1. If you are tracking your settings (recommended), remove /settings from .gitignore, then add your files and make a commit:
git add ./settings

git commit -m "Track setting files"

git push private