From a68806e78219faa0e0c43b4f356fd18e9f494cda Mon Sep 17 00:00:00 2001
From: Yuri Sizov <yuris@humnom.net>
Date: Wed, 4 Oct 2023 15:45:58 +0200
Subject: [PATCH] Move scripts used to bootstrap this repo to a dedicated
 folder

---
 .../bootstrap/generate-history.py                 | 15 +++++++++++++++
 .../bootstrap/generate-metadata.py                | 11 +++++++++++
 .../bootstrap/generate-releases.py                | 14 +++++++++++++-
 3 files changed, 39 insertions(+), 1 deletion(-)
 rename generate-history.py => tools/bootstrap/generate-history.py (73%)
 rename extract-hashes.py => tools/bootstrap/generate-metadata.py (94%)
 rename generate-releases.py => tools/bootstrap/generate-releases.py (93%)

diff --git a/generate-history.py b/tools/bootstrap/generate-history.py
similarity index 73%
rename from generate-history.py
rename to tools/bootstrap/generate-history.py
index 70d6772..2111700 100644
--- a/generate-history.py
+++ b/tools/bootstrap/generate-history.py
@@ -1,3 +1,18 @@
+### This script has been used to generate initial data for this repository
+### and is preserved as a reference. DO NOT USE IT.
+
+### Generate commit history adding each official release in order.
+###
+### Make sure JSON metadata files are put into the releases folder.
+### Using these files this script recreates the commit history,
+### placing each release at their approximate time and date of
+### publication. Each commit is tagged with the release identity.
+###
+### Make sure you do not rebase or otherwise change the history
+### afterwards, as that destroys git tags (they remain assigned
+### to old commits).
+
+
 import json
 import os
 import subprocess
diff --git a/extract-hashes.py b/tools/bootstrap/generate-metadata.py
similarity index 94%
rename from extract-hashes.py
rename to tools/bootstrap/generate-metadata.py
index 4266b2a..b18f0cf 100644
--- a/extract-hashes.py
+++ b/tools/bootstrap/generate-metadata.py
@@ -1,3 +1,14 @@
+### This script has been used to generate initial data for this repository
+### and is preserved as a reference. DO NOT USE IT.
+
+### Generate JSON metadata files for each official release of Godot.
+###
+### Files are put into a temporary folder temp/releases. To generate
+### the data we extract dates and commit hashes from releases published
+### on TuxFamily. We also extract SHA512 checksums for release files
+### where possible.
+
+
 import os
 import urllib.request
 import urllib.error
diff --git a/generate-releases.py b/tools/bootstrap/generate-releases.py
similarity index 93%
rename from generate-releases.py
rename to tools/bootstrap/generate-releases.py
index 23294c2..3fb2184 100644
--- a/generate-releases.py
+++ b/tools/bootstrap/generate-releases.py
@@ -1,8 +1,20 @@
+### This script has been used to generate initial data for this repository
+### and is preserved as a reference. DO NOT USE IT.
+
+### Generate GitHub releases for each official Godot release.
+###
+### For each release creates a canned release summary based on
+### release's characteristics, then publishes a new GitHub release
+### in the linked repository. Make sure to use gh to configure
+### the default repository for this project's folder.
+###
+### Generated release notes are available in temp/notes for examination.
+
+
 import json
 import os
 import subprocess
 import yaml
-from datetime import datetime
 
 
 website_versions = []