jjkiers/tzk
1
0
Fork 0
Code Issues Pull Requests Releases Activity

add publish step and option to skip a builder

Browse Source 
This will preserve the ability to skip a publish if I want to.
This commit is contained in:
Soren I. Bjornstad 2021-08-26 17:31:31 -05:00
parent 8beda01e41
commit 5951b38551
2 changed files with 37 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
builders.py
View File

@ -275,3 +275,22 @@ def set_tiddler_values(mappings: Dict[str, str]) -> None:
with tiddler_path.open("w") as f: with tiddler_path.open("w") as f:
f.writelines(tiddler_lines[0:first_blank_line_index+1]) f.writelines(tiddler_lines[0:first_blank_line_index+1])
f.write(new_text) f.write(new_text)
@tzk_builder
def publish_wiki_to_github(
output_folder: str = "output/public_site/",
commit_message: str = "publish checkpoint",
remote: str = "origin",
refspec: str = "master") -> None:
"Publish the wiki to GitHub"
os.chdir(output_folder)
if not os.path.isdir(".git"):
info(f"The output folder {output_folder} doesn't appear to be a Git repository. "
f"I'll try to make it one.")
git.exec("init")
git.exec("add", "-A")
git.exec("commit", "-m", commit_message)
git.exec("push", remote, refspec)

24
tzk.py
View File

@ -160,6 +160,13 @@ class BuildCommand(CliCommand):
metavar="PRODUCT", metavar="PRODUCT",
help="Name of the product you want to build (defined in your config file).", help="Name of the product you want to build (defined in your config file).",
) )
parser.add_argument(
"-s", "--skip-builder",
metavar="BUILDER_NAME",
help="Function name of a builder to skip even if part of the PRODUCT. "
"This option can be specified multiple times.",
action="append",
)
def _precheck(self, product: str) -> None: def _precheck(self, product: str) -> None:
if cm.products is None: if cm.products is None:
@ -180,18 +187,23 @@ class BuildCommand(CliCommand):
for idx, step in enumerate(steps, 1): for idx, step in enumerate(steps, 1):
if hasattr(step, '__doc__'): if hasattr(step, '__doc__'):
print(f"\ntzk: Step {idx}/{len(steps)}: {step.__doc__}") print(f"tzk: Step {idx}/{len(steps)}: {step.__doc__}")
else: else:
print(f"\ntzk: Step {idx}/{len(steps)}") print(f"tzk: Step {idx}/{len(steps)}")
if step.__name__ in args.skip_builder:
print(f"tzk: Skipping step {idx} due to --skip-builder parameter.")
continue
try: try:
step() step()
except BuildError as e: except BuildError as e:
print(f"tzk: ERROR: {str(e)}") print(f"tzk: ERROR: {str(e)}")
print(f"\ntzk: Build of product '{args.product}' failed on step {idx}, " print(f"tzk: Build of product '{args.product}' failed on step {idx}, "
f"backed by builder '{step.__name__}'.") f"backed by builder '{step.__name__}'.")
sys.exit(1) sys.exit(1)
except Exception: except Exception:
print(f"\ntzk: Build of product '{args.product}' failed on step {idx}: " print(f"tzk: Build of product '{args.product}' failed on step {idx}: "
f"unhandled exception. " f"unhandled exception. "
f"The original error follows:") f"The original error follows:")
traceback.print_exc() traceback.print_exc()
@ -200,10 +212,10 @@ class BuildCommand(CliCommand):
# TODO: This should run in a finally() block; leaving for now as it's convenient for development :) # TODO: This should run in a finally() block; leaving for now as it's convenient for development :)
for idx, step in enumerate(steps, 1): for idx, step in enumerate(steps, 1):
if hasattr(step, 'cleaner'): if hasattr(step, 'cleaner'):
print(f"\ntzk: Running cleanup routine for step {idx}...") print(f"tzk: Running cleanup routine for step {idx}...")
step.cleaner() step.cleaner()
print(f"\ntzk: Build of product '{args.product}' completed successfully.") print(f"tzk: Build of product '{args.product}' completed successfully.")
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()