README.md

Student Accomplice Pipeline

Description

This is the pipeline for BYU Animation's Student Accomplice (2024) short film, and is a fork of the previous film's pipeline.

Development started on CentOS 7, but final deployment is intended for a RHEL 8 derivative.

Since all of the film's files are on the department's fileserver and mounted at /groups/accomplice/ in the TMCB animation and gaming labs, this pipeline has no need for and so does not provide tools for sharing assets between users/computers.

Setting up a dev environment in the labs

1. Generate a GitHub SSH key and upload it to your GitHub

   • ssh-keygen -t ed25519 -C "[email protected]"
     cat ~/.ssh/github.pub

   • When it asks for a path, type '/users/animation/yournetid/.ssh/github'
   • Only provide a passphrase if you want to type that every time you push or pull
   • Go to https://github.com/settings/keys and add the contents of ~/.ssh/github.pub as a New SSH key
2. Make a local copy of the git repo

   cd ~/Documents
   git clone -c core.sshCommand='ssh -i ~/.ssh/github' [email protected]:Student-Accomplice-Pipeline-Team/accomplice_pipe.git
   cd accomplice_pipe

3. Configure the git repo to use the new SSH key and our git hooks

   git config --add --local core.sshCommand 'ssh -i ~/.ssh/github'
   git config --local core.hooksPath .githooks/

4. Check out your personal dev branch

   git checkout -B yourname-dev 
   # don't need -B if it already exists
   git push --set-upstream origin yourname-dev

Using your personal dev environment

1. Make changes the code. Edit the pipe code, modify some shelf tools, whatever your heart desires.
2. If you want, you can periodically take snapshots of your work with git commit.
   1. Save your work
   2. Stage your changes with git add path/to/file1 path/to/file2 ...
   3. Commit your chages with git commit -m "Message explaining what changes I made"
   4. Push your changes up to GitHub with git push
3. Test your changes. Make sure everything works the way you think it should and that nothing new is broken.
4. When your changes are ready to be added to production, create a pull request to merge your code into the prod branch of the GitHub repository:
   1. Make sure that your changes don't conflict with changes someone else has already made. Run git pull origin prod to make sure you have the most recent chages to the prod branch downloaded.
      • If git encounters an error downloading the most recent changes, it will tell you what the problem is and you'll need to resolve it before continuing.
   2. Once you have successfully run git pull origin prod, commit and push all your changes if you haven't already done so (see step 2)
   3. Next, go to the project page on GitHub and switch from prod to your dev branch (top left, underneath the name of the repo). If you have committed and pushed correctly, you should see a message that says something like "This branch is *X commit(s) ahead of prod.". Click on the Contribute button and press Open pull request
   4. Name your pull request and write a small description of what changes you are making.
   5. Make sure the merge mode is set to Squash and merge, then click the big green button to merge your changes into prod.
   6. Finally, navigate to /groups/accomplice/pipeline and run git pull to update production code with your changes.

Table of Contents

• Usage and features (for artists)

  • Maya
  • Houdini
  • Nuke

• Development (for programmers)

  • Maya
  • Houdini
  • Nuke

Usage & Features