Skip to content

Scripts and Git Workflows

This project keeps automation scripts in the repository root under scripts/. They are intentionally outside the godot/ folder so they remain editor-agnostic and can operate on the repository as a whole (root plus submodules).

What lives in scripts/:

  • deploy_docs_cloudflare.sh — Build and deploy the MkDocs site to Cloudflare Pages.
  • sync_docs_for_site.sh — Sync curated docs into the docs_site folder.
  • setup_docs_env.sh — Optional helpers for docs setup.
  • push_all_to_main.sh — Push the root repo and all submodules to origin/main, and update root submodule pointers.

Usage:

  • Deploy docs
  • bash scripts/deploy_docs_cloudflare.sh
  • Push all repos to main
  • bash scripts/push_all_to_main.sh

Notes:

  • Scripts assume Git Bash on Windows. If you use PowerShell, call through Git Bash.
  • The push helper only commits already-staged changes (root and submodules). Stage intentionally.
  • Submodules are switched to a main branch. If a submodule has another default branch, the script will create main from that remote default.