Proposed Sinopia & GitHub Workflow - LD4P/sinopia_sample_profiles GitHub Wiki

NB: This is not required for someone to work with Profiles & Resource Templates (or any other type of resources) within the Sinopia ecosystem. This is just a proposal for a workflow that gives some more structure to specification review by metadata and cataloging librarians, and has a technical skeleton that we can easily extend with existing software engineering tools & processes for more automated integration down the road.

Profile & Template Flow

This is a proposal for editing and adding new profiles and resource templates on your local machine, pushing to a hosted review space in GitHub, and having your colleagues review and merge your additions / changes to the 'master' copy of your shared profiles & resource templates. That 'master' copy is then what is updated within Sinopia by whomever in your team reviewed & merged the changes, ensuring that authorized users are ensuring the quality of profiles in both places.

In this setup, you would not support adding changes directly to profiles pushed to Sinopia (not going through GitHub review). Those changes would be overwritten upon any new release of the 'master' copy from your team's GitHub repository.

Overview of the Process:

1. Pull all the remote (GitHub) work locally
2. Make a new Branch
3. Add your changes to your Branch
4. Commit your changes to your Branch
5. Push your Branch up to a Branch in GitHub
6. Create Pull Request in GitHub to merge your Branch to the Master Branch
7. Have other people review & merge (or request changes)
8. Merge (or Close) Pull Requests to Master
9. Member of team then updates their team's Sinopia profiles with files in Master
10. Start again at bullet point 1

Shell (CLI / Terminal) Commands:

1. On local machine, change into my Git repository: cd cmharlow/github/ld4p/sinopia_sample_profiles
   1. Have local files that mirror timestamp + branch upstream in GitHub
   2. Have appropriate connection to GitHub repository via checking git remote show origin
2. On master branch (you can check by entering git checkout master), run git pull origin master
   1. Pull all changes down (you always want to do this before starting your own branch to add changes)
3. Open in editor, eyeball, add whatever. This adds your changes however on your local machine.
4. git checkout -b my-new-branch
   1. Create your working branch
5. git status
   1. Check what is new in that branch
6. git add example.json
   1. Add the items you want to check in
7. git commit -m 'adding my new json profile'
   1. Commit them to your branch with a commit message
8. git status
   1. Check now what is new in that branch
9. git push origin my-new-branch
   1. Push your committed changes up to your branch in the GitHub repository
10. Go to GitHub & create a PR. Have other people review & decide to merge (or not) that PR.
    1. Create a Pull Request by which someone reviews and approves your changes and merges them into master
11. For Sinopia, after the above, a credential team member might then re-submit any updated or new profiles & resource templates to Sinopia through the UI (or, eventually, programmatically)
12. git checkout master | git pull origin master
    1. Start the process all over again.