syncing branches

.github/workflows/branch_split.yml

@@ -0,0 +1,12 @@
+name: Curriculum Solution Branch Splitter
+
+on:
+  push:
+    branches: curriculum
+    paths: index.ipynb
+
+jobs:
+  Test_remote_action:
+    uses: learn-co-curriculum/dsc-github-actions-files/.github/workflows/[email protected]
+    secrets: inherit
+

splitter.py

@@ -0,0 +1,170 @@
+import json
+import os
+import subprocess
+from git import Repo, Git, GitCommandError
+import sys
+
+# CONSTANTS
+SOLUTION_TAG = "__SOLUTION__"
+CURRICULUM_BRANCH = "curriculum"
+MASTER_BRANCH = "master"
+SOLUTION_BRANCH = "solution"
+CUSTOM_COMMIT_MSG_FLAG = "-m"
+
+# FUNCTIONS
+
+
+def get_notebook_json(filename="index.ipynb"):
+    with open(filename, 'r') as f:
+        data = json.load(f)
+    return data
+
+
+def is_markdown_cell(cell):
+    return cell["cell_type"] == "markdown"
+
+
+def contains_tag(line):
+    # returns true for '# __SOLUTION__' or '#__SOLUTION__'
+    return any(tag in line.strip().split(" ") for tag in [SOLUTION_TAG, f"#{SOLUTION_TAG}"])
+
+
+def is_solution_cell(cell):
+    if cell["cell_type"] != "code":
+        return False
+
+    # does any line of the cell have the SOLUTION tag anywhere in it
+    found_tag = [True for line in cell["source"] if contains_tag(line)]
+
+    return bool(len(found_tag))
+
+
+# removes __SOLUTON__ line from tagged code cells
+def untag(cell):
+    if cell["cell_type"] != "code":
+        return cell
+
+    source = [line for line in cell["source"] if not contains_tag(line)]
+
+    cell.update({"source": source})
+    return cell
+
+
+def create_master_notebook(nb):
+    cells = [
+        cell for cell in nb["cells"] if for_master(cell)
+    ]
+
+    nb.update({"cells": cells})
+    return nb
+
+
+def for_master(cell):
+    return is_markdown_cell(cell) or not is_solution_cell(cell)
+
+
+def for_sol(cell):
+    return is_markdown_cell(cell) or is_solution_cell(cell)
+
+
+def create_sol_notebook(nb):
+    cells = [
+        untag(cell) for cell in nb["cells"] if for_sol(cell)
+    ]
+
+    nb.update({"cells": cells})
+    return nb
+
+def write_new_notebook(notebook):
+    f = open("index.ipynb", "w")
+    f.write(json.dumps(notebook))
+    f.close()
+
+def notebook_to_markdown():
+    subprocess.call(["jupyter", "nbconvert", "index.ipynb",  "--to", "markdown"])
+    subprocess.call(["mv", "index.md", "README.md"])
+
+
+def sync_branch(repo, branch, notebook, msg="Curriculum Auto-Sync"):
+    # switch to branch, do nothing if does not exist
+    try:
+        repo.git.checkout(branch)
+        branch_exists = True
+    except GitCommandError:
+        branch_exists = False
+
+    if branch_exists:
+        # get all files from curriculum branch and put onto this branch,
+        # (the notebook and readme will be overwritten in the subsequent steps)
+        # Interesting use of the `checkout` command
+        # https://superuser.com/questions/692794/how-can-i-get-all-the-files-from-one-git-branch-and-put-them-into-the-current-b/1431858#1431858
+        repo.git.checkout(CURRICULUM_BRANCH, ".")
+
+        # delete current images, they'll be regenerated along with the notebook
+        subprocess.call(["rm", "-rf", "index_files"])
+
+        # write index.ipynb
+        write_new_notebook(notebook)
+
+        # generate markdown
+        notebook_to_markdown()
+
+        # add, commit, push
+        add_and_commit(repo, msg)
+        print(f"pushing to remote {branch} branch")
+        repo.git.push("origin", branch)
+
+def get_commit_message(repo):
+    # get commit message from repo or custom flag
+    sys_args = list(sys.argv)
+    i = sys_args.index(CUSTOM_COMMIT_MSG_FLAG) if CUSTOM_COMMIT_MSG_FLAG in sys_args else None
+
+    return sys_args[i + 1] if i else repo.head.commit.message
+
+
+def add_and_commit(repo, commit_msg):
+    repo.git.add(".")
+    try:
+        repo.git.commit("-m", commit_msg)
+    except GitCommandError:
+        print("Nothing to commit")
+
+# RUN
+# ======================
+
+# Identity
+git_ssh_identity_file = os.path.expanduser('~/.ssh/id_rsa')
+git_ssh_cmd = f'ssh -i {git_ssh_identity_file}'
+Git().custom_environment(GIT_SSH_COMMAND=git_ssh_cmd)
+
+repo = Repo(os.getcwd())
+# handling for updated main branch naming convention ensuring correct branch name
+try:
+    repo.git.checkout('main')
+    MASTER_BRANCH = 'main'
+except GitCommandError:
+    print('The main branch is not named "main"')
+    MASTER_BRANCH = 'master'
+
+try:
+    repo.git.checkout(CURRICULUM_BRANCH)
+except GitCommandError:
+    raise Exception(f"A branch called {CURRICULUM_BRANCH} must exist")
+
+commit_message = get_commit_message(repo)
+
+notebook_to_markdown()
+
+add_and_commit(repo, commit_message)
+print(f"pushing to remote {CURRICULUM_BRANCH} branch")
+repo.git.push("origin", CURRICULUM_BRANCH)
+
+notebook_json   = get_notebook_json()
+master_notebook = create_master_notebook(dict(notebook_json)) # pass a copy
+sol_notebook    = create_sol_notebook(dict(notebook_json)) # pass a copy
+
+sync_branch(repo, MASTER_BRANCH, master_notebook, msg=commit_message)
+sync_branch(repo, SOLUTION_BRANCH, sol_notebook, msg=commit_message)
+
+# leave user on curriculum branch
+repo.git.checkout(CURRICULUM_BRANCH)