makefile now only runs modified tutorials by default

Author: adrn

.github/get_modified_tutorials.py

@@ -2,24 +2,34 @@
 from git import Repo
 
 
-def main(repo_path):
+def main(repo_path, main_branch, **kw):
     r = Repo(repo_path)
 
     # NOTE: assumes the main branch is named "main"
     files_changed = r.git.diff(
-        f'{str(r.head.object.hexsha)}..origin/main',
+        f'{str(r.head.object.hexsha)}..{main_branch}',
         '--name-only').split("\n")
     files_changed = [f for f in files_changed if f.endswith('.ipynb')]
     if files_changed:
         print(" ".join(files_changed))
 
 
 if __name__ == "__main__":
-    try:
-        repo_path = sys.argv[1]
-    except IndexError:
-        print("ERROR: did not receive a repo path.\n"
-              "Usage: get_modified_tutorials.py <ROOT TUTORIALS REPO PATH>")
-        sys.exit(1)
+    from argparse import ArgumentParser
 
-    main(repo_path)
+    parser = ArgumentParser()
+    parser.add_argument(
+        '-r', '--repo-path',
+        dest='repo_path',
+        default='.',
+        help='The path to the root of the astropy-tutorials repository folder.'
+    )
+    parser.add_argument(
+        '--main-branch',
+        dest='main_branch',
+        default='main',
+        help=('The name of the main branch to compare against. Default is '
+              '"main" but on CI it should be origin/main.')
+    )
+    args = parser.parse_args()
+    main(**vars(args))

Makefile

@@ -1,17 +1,27 @@
-default: all
+default: build
 
-all: envcheck execute convert
+TUTORIALS_MAIN_BRANCH ?= main
+MODIFIED := $(shell python .github/get_modified_tutorials.py --main-branch $(TUTORIALS_MAIN_BRANCH))
+
+build: envcheck execute convert
+buildall: envcheck executeall convertall
 
 envcheck:
 	python -c "import pkg_resources; pkg_resources.require(open('pip-requirements.txt', mode='r')); print('Your environment is all set!')"
 
 execute:
-	nbcollection execute --timeout=600 --flatten --build-path=. -v tutorials
+	nbcollection execute --timeout=600 --flatten --build-path=. -v ${MODIFIED}
 
 convert:
+	nbcollection convert --flatten --build-path=. -v --make-index --index-template=templates/index.tpl ${MODIFIED}
+
+executeall:
+	nbcollection execute --timeout=600 --flatten --build-path=. -v tutorials
+
+convertall:
 	nbcollection convert --flatten --build-path=. -v --make-index --index-template=templates/index.tpl tutorials
 
 clean:
 	rm -rf _build
 
-.PHONY: all clean execute convert
+.PHONY: all clean execute convert executeall convertall build buildall